Class: CacheURI
@divine/uri.CacheURI
The cache: protocol handler can be used to store (large and small) temporary files on disk.
A cached file will be automatically pruned after 1 hour, if remove has not been called manually.
Hierarchy
↳
CacheURI
Constructors
constructor
• new CacheURI(uri)
Parameters
| Name | Type |
|---|---|
uri | URI |
Overrides
Defined in
Properties
href
• Readonly href: string
This URI's string representation. Unlike in URL, this property may not be changed/updated.
Inherited from
Defined in
origin
• Readonly origin: string
This URI's origin. Unlike in URL, this property may not be changed/updated.
Inherited from
Defined in
protocol
• Readonly protocol: string
This URI's protocol. Unlike in URL, this property may not be changed/updated.
Inherited from
Defined in
selectors
• selectors: Object
All selectors that may apply to this URI. Use addSelector to modify this property.
Type declaration
| Name | Type | Description |
|---|---|---|
auth? | AuthSelector[] | Authentication/Credentials selectors. See AuthSelector. |
headers? | HeadersSelector[] | Headers selectors. See HeadersSelector. |
params? | ParamsSelector[] | Parameter selectos. See ParamsSelector. |
session? | SessionSelector[] | Session selectors. Only used internally. |
Inherited from
Defined in
FIELDS
▪ Static Readonly FIELDS: symbol = FIELDS
An alias for FIELDS.
Inherited from
Defined in
FINALIZE
▪ Static Readonly FINALIZE: symbol = FINALIZE
An alias for FIELDS.
Inherited from
Defined in
HEADERS
▪ Static Readonly HEADERS: symbol = HEADERS
An alias for HEADERS.
Inherited from
Defined in
NULL
▪ Static Readonly NULL: symbol = NULL
An alias for NULL.
Inherited from
Defined in
STATUS
▪ Static Readonly STATUS: symbol = STATUS
An alias for STATUS.
Inherited from
Defined in
STATUS_TEXT
▪ Static Readonly STATUS_TEXT: symbol = STATUS_TEXT
An alias for STATUS_TEXT.
Inherited from
Defined in
VOID
▪ Static Readonly VOID: symbol = VOID
An alias for VOID.
Inherited from
Defined in
Methods
$
▸ $(strings, ...values): URI
Constructs a new URI, relative to this URI, from a template string, percent-encoding all arguments.
Example:
const base = new URI('http://api.example.com/v1/');
const info = await base.$`items/${item}/info`.load();
Parameters
| Name | Type | Description |
|---|---|---|
strings | TemplateStringsArray | The template string array. |
...values | unknown[] | The values to be encoded. |
Returns
A new URI subclass instance.
Inherited from
Defined in
[asyncIterator]
▸ [asyncIterator](): AsyncIterator<Buffer, any, undefined> & Metadata
All URIs are AsyncIterable<Buffer>. This method implements that interface by calling
load(stream).
Returns
AsyncIterator<Buffer, any, undefined> & Metadata
An AsyncIterator<Buffer> stream.
Inherited from
Defined in
_getAuthorization
▸ Protected _getAuthorization(req, payload?, challenges?): Promise<undefined | Authorization>
Parameters
| Name | Type |
|---|---|
req | AuthSchemeRequest |
payload? | Buffer | AsyncIterable<Buffer> |
challenges? | WWWAuthenticate[] |
Returns
Promise<undefined | Authorization>
Inherited from
Defined in
_getBestSelector
▸ Protected _getBestSelector<T>(sels, challenge?): null | T
Type parameters
| Name | Type |
|---|---|
T | extends SelectorBase |
Parameters
| Name | Type |
|---|---|
sels | undefined | T[] |
challenge? | WWWAuthenticate |
Returns
null | T
Inherited from
Defined in
_guessContentType
▸ Protected _guessContentType(knownContentType?): undefined | ContentType
Parameters
| Name | Type |
|---|---|
knownContentType? | string | ContentType |
Returns
undefined | ContentType
Inherited from
Defined in
_makeIOError
▸ Protected _makeIOError(err): IOError
Parameters
| Name | Type |
|---|---|
err | unknown |
Returns
Inherited from
Defined in
addSelector
▸ addSelector<T>(selector): CacheURI
Adds a new selector to this URI.
Selectors is a way to specify in what situations some kind of parameters or configuration is valid. When some kind of configuration is required (such as authentication of connection parameters), all registered selectors are evaluated and based on the matching score, the best selector is chosen. The more specific a selector is, the higher the score it will receive if it matches.
Based on this, it's possible to limit the scope of credentials or to configure certain HTTP headers to be sent to a specific set of servers.
It's also perfectly valid not to specify a selector for some kind of parameters. As long as there is only one kind of this configuration, it will apply unconditionally.
Throws
TypeError If the selector to add is invalid.
Type parameters
| Name | Type |
|---|---|
T | extends AuthSelector | HeadersSelector | ParamsSelector | SessionSelector |
Parameters
| Name | Type | Description |
|---|---|---|
selector | T | The selector to add. |
Returns
This URI.
Inherited from
Defined in
append
▸ append<T, D>(data, sendCT?, recvCT?): Promise<T & Metadata>
See append.
Type parameters
| Name | Type |
|---|---|
T | extends object |
D | unknown |
Parameters
| Name | Type |
|---|---|
data | D |
sendCT? | string | ContentType |
recvCT? | undefined |
Returns
Promise<T & Metadata>
Overrides
Defined in
close
▸ close(): Promise<void>
Closes this URI and frees any temporary resources in use.
URIs are usually stateless, but some protocols may use a connection pool, and this method can be used to shut down the pool and all remaining connections that may otherwise prevent the process from exiting.
Returns
Promise<void>
Inherited from
Defined in
info
▸ info<T>(): Promise<T & Metadata>
See info.
Type parameters
| Name | Type |
|---|---|
T | extends DirectoryEntry |
Returns
Promise<T & Metadata>
Overrides
Defined in
list
▸ list<T>(): Promise<T[] & Metadata>
This method will return information about this URI's children/subresources, if the subclass supports it.
The actual operation depends on what kind of URI this is. See info for a common example.
Throws
IOError On I/O errors or if the subclass does not support this method.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends DirectoryEntry | The actual type of information record returned. Must extend DirectoryEntry. |
Returns
Promise<T[] & Metadata>
An array of information record describing the subresources.
Inherited from
Defined in
load
▸ load<T>(recvCT?): Promise<T & Metadata>
See load.
Type parameters
| Name | Type |
|---|---|
T | extends object |
Parameters
| Name | Type |
|---|---|
recvCT? | string | ContentType |
Returns
Promise<T & Metadata>
Overrides
Defined in
modify
▸ modify<T, D>(data, sendCT?, recvCT?): Promise<T & Metadata>
Modifies/patches data the resource this URI references, if the subclass supports it.
The actual operation depends on what kind of URI this is. See modify or modify for two common examples.
See parse for details about the returned object (never a primitive). You may always set recvCT
to ContentType.bytes to receive a Node.js Buffer and ContentType.stream for an
AsyncIterable<Buffer> stream, if you prefer raw data.
Throws
IOError On I/O errors or if the subclass does not support this method.
Throws
ParserError If the media type is unsupported or the parser fails to parse the response.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends object | The actual type returned. |
D | unknown | The type of patch data to apply. |
Parameters
| Name | Type | Description |
|---|---|---|
data | D | The patch data to apply. |
sendCT? | string | ContentType | Override the default data serializer. |
recvCT? | string | ContentType | Override the default response parser. |
Returns
Promise<T & Metadata>
If the operation produced a result, it will be parsed as recvCT into an object,
including MetaData.
Inherited from
Defined in
query
▸ query<T>(...args): Promise<T & Metadata>
A generic method that sends/applies some kind of query to the resource and returns a response.
The actual operation depends on what kind of URI this is. See query or query for two common examples.
Throws
IOError On I/O errors or if the subclass does not support this method.
Throws
ParserError If the media type is unsupported or the parser fails to parse the response.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends object | The actual type returned. |
Parameters
| Name | Type | Description |
|---|---|---|
...args | unknown[] | Depends on the subclass. |
Returns
Promise<T & Metadata>
If the operation produced a result, it will returned together with MetaData.
Inherited from
Defined in
remove
▸ remove<T>(recvCT?): Promise<T & Metadata>
See remove.
Type parameters
| Name | Type |
|---|---|
T | extends object |
Parameters
| Name | Type |
|---|---|
recvCT? | undefined |
Returns
Promise<T & Metadata>
Overrides
Defined in
uri/src/protocols/cache.ts:101
save
▸ save<T, D>(data, sendCT?, recvCT?): Promise<T & Metadata>
See save.
Type parameters
| Name | Type |
|---|---|
T | extends object |
D | unknown |
Parameters
| Name | Type |
|---|---|
data | D |
sendCT? | string | ContentType |
recvCT? | undefined |
Returns
Promise<T & Metadata>
Overrides
Defined in
watch
▸ watch(): AsyncIterable<FileWatchEvent & Metadata>
See watch.
Returns
AsyncIterable<FileWatchEvent & Metadata>
Overrides
Defined in
uri/src/protocols/cache.ts:106
$
▸ Static $(strings, ...values): URI
Creates a new URI from a template string, percent-encoding all arguments.
Example:
const href = URI.$`http://${host}/blobs/${blob}?as=${ct}
Parameters
| Name | Type | Description |
|---|---|---|
strings | TemplateStringsArray | The template string array. |
...values | unknown[] | The values to be encoded. |
Returns
A new URI subclass instance.
Inherited from
Defined in
create
▸ Static create(type): CacheURI
Creates a new cached file resource.
Then use save to store data and load to retrieve it back.
Parameters
| Name | Type | Description |
|---|---|---|
type | string | ContentType | The cache file's media type. |
Returns
A new CacheURI instance.
Defined in
register
▸ Static register(protocol, uri): typeof URI
Registers a new URI protocol. All subclasses must register their URL protocol support with this method.
Parameters
| Name | Type | Description |
|---|---|---|
protocol | string | The URL protocol to register. Must include the trailing colon. |
uri | typeof URI | The URI subclass. |
Returns
typeof URI
The URI baseclass (for chaining).