Interface RootDocumentFetch

The settled load-time fetch.

interface RootDocumentFetch {
    outcomes: ReadonlyMap<"zarr.json" | ".zattrs", RootDocOutcome>;
    served:
        | {
            doc: "zarr.json"
            | ".zattrs";
            bytes: Uint8Array<ArrayBuffer>;
            etag: string | null;
        }
        | null;
    token(): Promise<RemoteValidationToken | null>;
    peekToken(): RemoteValidationToken | null | undefined;
}

Index

Properties

outcomes served

Methods

token peekToken

Properties

`Readonly`outcomes

outcomes: ReadonlyMap<"zarr.json" | ".zattrs", RootDocOutcome>

Per-document outcome, in request order. A document never requested is absent.

`Readonly`served

served:
    | {
        doc: "zarr.json"
        | ".zattrs";
        bytes: Uint8Array<ArrayBuffer>;
        etag: string | null;
    }
    | null

The document that answered 2xx, or null when none did.

Methods

token

token(): Promise<RemoteValidationToken | null>
The validation token for served, derived once and memoised; null when nothing was served or the body is not JSON.

Returns Promise<RemoteValidationToken | null>
- Defined in src/cache/root-document-prefetch.ts:69

peekToken

peekToken(): RemoteValidationToken | null | undefined
The token if token has already resolved, else undefined.

Returns RemoteValidationToken | null | undefined
- Defined in src/cache/root-document-prefetch.ts:71

Interface RootDocumentFetch

Index

Properties

Methods

Properties

`Readonly`outcomes

`Readonly`served

Methods

token

Returns Promise<RemoteValidationToken | null>

peekToken

Returns RemoteValidationToken | null | undefined

Settings

On This Page

Interface RootDocumentFetch

Index

Properties

Methods

Properties

Readonlyoutcomes

Readonlyserved

Methods

token

Returns Promise<RemoteValidationToken | null>

peekToken

Returns RemoteValidationToken | null | undefined

Settings

On This Page

`Readonly`outcomes

`Readonly`served