@helia/verified-fetch
    Preparing search index...

    Interface PluginContext

    Represents the ephemeral, modifiable state used by the pipeline.

    • Mutable: Evolves as you walk the plugin chain.
    • Shared Data: Allows plugins to communicate partial results, discovered data, or interim errors.
    • Ephemeral: Typically discarded once fetch(...) completes.
    interface PluginContext {
        accept: AcceptHeader[];
        blockstore: Blockstore;
        headers: Headers;
        ipfsRoots: CID<unknown, number, number, Version>[];
        options?: Omit<VerifiedFetchInit, "signal"> & AbortOptions;
        range?: RangeHeader;
        requestedMimeTypes: RequestedMimeType[];
        resource: Resource;
        serverTiming: ServerTiming;
        terminalElement: UnixFSEntry;
        ttl: number;
        url: URL;
        onProgress?(evt: ProgressEvent): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accept blockstore headers ipfsRoots options? range? requestedMimeTypes resource serverTiming terminalElement ttl url

    Methods

    onProgress?

    Properties

    accept: AcceptHeader[]

    These are the response representations that the user requested and we support given the CID that is being requested

    blockstore: Blockstore

    The blockstore is used to load data from the IPFS network

    headers: Headers

    Any passed headers from the fetch init arg

    ipfsRoots: CID<unknown, number, number, Version>[]
    options?: Omit<VerifiedFetchInit, "signal"> & AbortOptions

    Onward options to pass to async operations

    range?: RangeHeader

    If present the user requested a subset of bytes using the Range header

    requestedMimeTypes: RequestedMimeType[]

    The mime types and options the user requested - these may be different from the allowed response representations in PluginContext.accept

    resource: Resource

    The resource that was requested by the user

    serverTiming: ServerTiming

    Any async operations should be invoked using server timings to allow introspection by the user

    terminalElement: UnixFSEntry
    ttl: number
    url: URL

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods