IFClite TypeScript API
    Preparing search index...

    Interface FoundationRequestOptions

    @ifc-lite/opencde-foundation — client for the buildingSMART OpenCDE Foundation API (https://github.com/buildingSMART/foundation-API): the services and conventions every OpenCDE API (BCF, Documents, ...) shares — /foundation/versions discovery, OAuth2 /auth discovery and token flows, and /current-user. @ifc-lite/bcf-api and @ifc-lite/documents-api both build their clients on top of this package.

    interface FoundationRequestOptions {
        body?: unknown;
        headers?: Record<string, string>;
        method?: string;
        query?: Record<string, string | number | undefined>;
        signal?: AbortSignal;
        timeoutMs?: number;
    }
    Index
    body? headers? method? query? signal? timeoutMs?

    Optionalbody

    body?: unknown
    headers?: Record<string, string>

    Extra request headers; Authorization is always supplied by the token provider.

    method?: string
    query?: Record<string, string | number | undefined>
    signal?: AbortSignal

    See HttpRequestOptions.signal: a rejection after dispatch is an unknown outcome.

    timeoutMs?: number

    Wall-clock limit in milliseconds.

    Settings
    Member Visibility

    On This Page
    Properties