source-graph-stream-client
    Preparing search index...

    Type Alias SourceGraphClientOptions

    Options for configuring the SourceGraphClient.

    https://sourcegraph.com/docs/api/stream_api

    type SourceGraphClientOptions = {
        accessToken?: string;
        init?: RequestInit;
        oauthToken?: string;
        throwOnError?: boolean;
        url: string;
    }
    Index

    Properties

    accessToken? init? oauthToken? throwOnError? url

    Properties

    accessToken?: string

    Sourcegraph access token or OAuth token with user:all scope. See GraphQL API authentication for details on token refresh and expiration handling.

    init?: RequestInit

    Optional fetch request initialization options.

    oauthToken?: string
    throwOnError?: boolean

    If true, will throw an if the parsing of a chunk fails.

    url: string

    The URL of your Sourcegraph instance, or https://sourcegraph.com.

    "https://example.sourcegraph,com/.api/search/stream"

    Settings

    Member Visibility

    On This Page

    Properties