@forge-dashboard/sdk-node
    Preparing search index...

    Interface ClientOptions

    A Node/TypeScript client for the forge-dashboard REST API (github.com/alrayyes/forge-dashboard), generated from its OpenAPI spec with openapi-typescript + openapi-fetch.

    Authenticate with a personal API token (POST /api/tokens on a running instance, signed in as yourself first) -- the real headless alternative forge-dashboard's spec documents to its browser session cookie, and the one this SDK actually uses. Pass it to createForgeDashboardClient or set FORGE_DASHBOARD_TOKEN. See the README for the full explanation and an example.

    interface ClientOptions {
        fetch?: (input: Request) => Promise<Response>;
        retry?: Partial<RetryConfig>;
        token?: string;
    }
    Index
    fetch? retry? token?
    fetch?: (input: Request) => Promise<Response>

    Replaces the underlying fetch. The retry wrapper (see retry) wraps whatever this is, so pass something with its own request behavior already configured (a proxying fetch, a test double) rather than re-implementing retry yourself.

    retry?: Partial<RetryConfig>

    Overrides the default retry policy.

    token?: string

    A forge-dashboard personal API token, generated from the dashboard's own Settings page (POST /api/tokens, signed in as yourself first). Overrides FORGE_DASHBOARD_TOKEN when both are set. See the README's "Authentication" section -- this is the real headless alternative forge-dashboard's spec documents to its browser session cookie.

    Settings
    Member Visibility

    On This Page
    Properties