Stone.js API
    Preparing search index...

    Interface HttpSourceOptions

    Options for the HTTP source (covers GitHub raw files, gists, any URL).

    interface HttpSourceOptions {
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        format?: ConfigFileFormat;
        headers?: Record<string, string>;
        url: string;
    }
    Index
    fetch? format? headers? url
    fetch?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }

    A fetch implementation to use (defaults to the global one).

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | Request | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | Request | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    format?: ConfigFileFormat

    The format (inferred from the URL extension when omitted, defaults to json).

    headers?: Record<string, string>

    Request headers (e.g. an authorization token for a private repo).

    url: string

    The URL to fetch.

    Settings
    Member Visibility

    On This Page
    Properties