API Referenceregistry-clientcache-entry

@vltpkg/registry-client/cache-entry

new CacheEntry(
   statusCode,
   headers,
   __namedParameters): CacheEntry

Defined in: src/registry-client/src/cache-entry.ts:150

Accessors

_body

Get Signature

get _body(): Uint8Array

Defined in: src/registry-client/src/cache-entry.ts:365

Returns the body as a single Uint8Array, concatenating parts if needed.

body

Get Signature

get body(): Uint8Array<ArrayBufferLike> | Record<string, any>

Defined in: src/registry-client/src/cache-entry.ts:469

Returns

Uint8Array<ArrayBufferLike> | Record<string, any>

cacheControl

Get Signature

get cacheControl(): CacheControl

Defined in: src/registry-client/src/cache-entry.ts:265

contentType

Get Signature

get contentType(): string

Defined in: src/registry-client/src/cache-entry.ts:288

date

Get Signature

get date(): undefined | Date

Defined in: src/registry-client/src/cache-entry.ts:246

fromCache

Get Signature

get fromCache(): boolean

Defined in: src/registry-client/src/cache-entry.ts:343

True when this entry was decoded from the on-disk cache.

headers

Get Signature

get headers(): Uint8Array<ArrayBufferLike>[]

Defined in: src/registry-client/src/cache-entry.ts:358

headSize

Get Signature

get headSize(): undefined | number

Defined in: src/registry-client/src/cache-entry.ts:351

Byte length of the encoded head (4-byte length prefix + status + headers). Set when decoded from cache or after encodeHead().

integrity

Get Signature

get integrity(): undefined | `sha512-${string}`

Defined in: src/registry-client/src/cache-entry.ts:428

Set Signature

set integrity(i): void

Defined in: src/registry-client/src/cache-entry.ts:422

integrityActual

Get Signature

get integrityActual(): `sha512-${string}`

Defined in: src/registry-client/src/cache-entry.ts:408

Set Signature

set integrityActual(i): void

Defined in: src/registry-client/src/cache-entry.ts:417

isGzip

Get Signature

get isGzip(): boolean

Defined in: src/registry-client/src/cache-entry.ts:491

isJSON

Get Signature

get isJSON(): boolean

Defined in: src/registry-client/src/cache-entry.ts:474

maxAge

Get Signature

get maxAge(): number

Defined in: src/registry-client/src/cache-entry.ts:254

staleWhileRevalidate

Get Signature

get staleWhileRevalidate(): boolean

Defined in: src/registry-client/src/cache-entry.ts:273

statusCode

Get Signature

get statusCode(): number

Defined in: src/registry-client/src/cache-entry.ts:355

valid

Get Signature

get valid(): boolean

Defined in: src/registry-client/src/cache-entry.ts:300

Methods

[kCustomInspect]()

kCustomInspect: string

Defined in: src/registry-client/src/cache-entry.ts:237

addBody()

addBody(b): void

Defined in: src/registry-client/src/cache-entry.ts:328

Add contents to the entry body.

buffer()

buffer(): Buffer

Defined in: src/registry-client/src/cache-entry.ts:459

Return the body of the entry as a Buffer

checkIntegrity()

checkIntegrity(context): this is CacheEntry & { integrity: `sha512-${string}` }

Defined in: src/registry-client/src/cache-entry.ts:392

Check that the sri integrity string that was provided to the ctor matches the body that we actually received. This should only be called AFTER the entire body has been completely downloaded.

This method will throw if the integrity values do not match.

Note that this will usually not be true if the value is coming out of the cache, because the cache entries are un-gzipped in place. It should only be called for artifacts that come from an actual http response.

Returns true if anything was actually verified.

Parameters

context

ErrorCauseOptions = {}

Returns

this is CacheEntry & { integrity: `sha512-${string}` }

encode()

encode(): Buffer

Defined in: src/registry-client/src/cache-entry.ts:709

Encode the entry as a single Buffer for writing to the cache

Returns

Buffer

encodeHead()

encodeHead(): Buffer

Defined in: src/registry-client/src/cache-entry.ts:674

Encode status + headers (no body) as they appear at the start of an on-disk cache file.

Returns

Buffer

getHeader()

getHeader(h): undefined | Uint8Array<ArrayBufferLike>

Defined in: src/registry-client/src/cache-entry.ts:435

Give it a key, and it’ll return the buffer of that header value

Parameters

h

string

Returns

undefined | Uint8Array<ArrayBufferLike>

getHeaderString()

getHeaderString(h): undefined | string

Defined in: src/registry-client/src/cache-entry.ts:442

Give it a key, and it’ll return the decoded string of that header value

Parameters

h

string

Returns

undefined | string

json()

json(): JSONObj

Defined in: src/registry-client/src/cache-entry.ts:563

Parse the entry body as JSON and return the result

Returns

JSONObj

setHeader()

setHeader(h, value): void

Defined in: src/registry-client/src/cache-entry.ts:452

Set a header to a specific value

Parameters

h

string

value

string | Uint8Array<ArrayBufferLike>

Returns

void

text()

text(): string

Defined in: src/registry-client/src/cache-entry.ts:555

Return the body of the entry as utf8 text Automatically unzips if the content is gzip encoded

Returns

string

toJSON()

toJSON(): object

Defined in: src/registry-client/src/cache-entry.ts:197

Returns

object

unzip()

unzip(): boolean

Defined in: src/registry-client/src/cache-entry.ts:512

Un-gzip encode the body. Returns true if it was previously gzip (so something was done), otherwise returns false.

Returns

boolean

decode()

static decode(buffer, options): CacheEntry

Defined in: src/registry-client/src/cache-entry.ts:626

Pass the contents of a @vltpkg/cache.Cache object as a buffer, and this static method will decode it into a CacheEntry representing the cached response.

Parameters

buffer

Uint8Array

options

CacheEntryOptions = {}

Returns

CacheEntry

decodeHead()

static decodeHead(buffer): CacheEntry

Defined in: src/registry-client/src/cache-entry.ts:608

Decode only the status/headers from an encoded cache buffer. The body is not read; headSize records how many bytes the head occupies so a later encodeHead() can be patched in place.

Parameters

buffer

Uint8Array

Returns

CacheEntry

isGzipEntry()

static isGzipEntry(buffer): boolean

Defined in: src/registry-client/src/cache-entry.ts:663

Parameters

buffer

Uint8Array

Returns

boolean

Type Aliases

CacheEntryOptions

type CacheEntryOptions = object

Defined in: src/registry-client/src/cache-entry.ts:77

Type declaration

body?

optional body: Uint8Array;

An optional body to use.

Adopted as-is (no copy). The caller must not mutate or reuse it. Used when decoding a cache entry from a buffer. Do not call addBody after providing this. Worker-thread transfers must copy or structuredClone first so the cache ArrayBuffer is not detached.

contentLength?

optional contentLength: number;

An optional content length of the body to use, if undefined the content-length header will be used.

integrity?

optional integrity: Integrity;

The expected integrity value for this response body

stale-while-revalidate-factor?

optional stale-while-revalidate-factor: number;

If the server does not serve a stale-while-revalidate value in the cache-control header, then this multiplier is applied to the max-age or s-maxage values.

By default, this is 60, so for example a response that is cacheable for 5 minutes will allow a stale response while revalidating for up to 5 hours.

If the server does provide a stale-while-revalidate value, then that is always used.

Set to 0 to prevent any stale-while-revalidate behavior unless explicitly allowed by the server’s cache-control header.

trustIntegrity?

optional trustIntegrity: boolean;

Whether to trust the integrity, or calculate the actual value.

This indicates that we just accept whatever the integrity is as the actual integrity for saving back to the cache, because it’s coming directly from the registry that we fetched a packument from, and is an initial gzipped artifact request.

JSONObj

type JSONObj = Record<string, JSONField>

Defined in: src/registry-client/src/cache-entry.ts:36

On this page

@vltpkg/registry-client/cache-entry