Shoalrun documentation frameworkMenu
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Code API reference

ManifestContentSourceOptions

Configuration for opening a static content-export manifest.

Updated
Read as Markdown

Type shoalrun.content.ManifestContentSourceOptions

type ManifestContentSourceOptions = {
    manifestUrl: string | URL;
    fetch?: typeof globalThis.fetch;
    signal?: AbortSignal;
    limits?: ContentDeliveryLimits;
};

Configuration for opening a static content-export manifest.

Fields

Name Type Required / default Description
fetch ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined Optional Fetch implementation. Defaults to globalThis.fetch.
limits ContentDeliveryLimits | undefined Optional Inventory and representation bounds.
manifestUrl string | URL Required Manifest URL; a browser resolves relative URLs against its current location.
signal AbortSignal | undefined Optional Cancel the opening request. Use get's signal to cancel an individual read.

shoalrun.content.ManifestContentSourceOptions.fetch

Property shoalrun.content.ManifestContentSourceOptions.fetch

fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined

Fetch implementation. Defaults to globalThis.fetch.

Type: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined

Optional

shoalrun.content.ManifestContentSourceOptions.limits

Property shoalrun.content.ManifestContentSourceOptions.limits

limits?: ContentDeliveryLimits | undefined

Inventory and representation bounds.

Type: ContentDeliveryLimits | undefined

Optional

shoalrun.content.ManifestContentSourceOptions.manifestUrl

Property shoalrun.content.ManifestContentSourceOptions.manifestUrl

manifestUrl: string | URL

Manifest URL; a browser resolves relative URLs against its current location.

Type: string | URL

Required

shoalrun.content.ManifestContentSourceOptions.signal

Property shoalrun.content.ManifestContentSourceOptions.signal

signal?: AbortSignal | undefined

Cancel the opening request. Use get's signal to cancel an individual read.

Type: AbortSignal | undefined

Optional