Class Client<UserContext>

Type Parameters

  • UserContext extends object = object

Hierarchy

  • Client

    Constructors

    constructor

    Properties

    context credentials? logger middleware prefix

    Methods

    fetch issuer send terminalware

    Constructors

    constructor

    Properties

    Protected context

    context: MiddlewareExecutionContext<ClientMiddlewareExecutionContext & UserContext>

    Shares information and functionality between middlewares. For example, the default middleware execution context always includes a Pino logger instance.

    Optional Readonly credentials

    credentials?: CredentialProvider

    Expose the credential provider as readonly so developers can interact with it.

    Protected Readonly logger

    logger: Logger

    A logger library compatible with Pino for logging in middleware layers.

    Readonly middleware

    middleware: MiddlewareStack<any, any, MiddlewareExecutionContext<ClientMiddlewareExecutionContext & UserContext>> = ...

    Expose the middleware stack as readonly so developers can add additional middleware for a specific client.

    Readonly prefix

    prefix: string

    Expose the prefix for other extensions to match with.

    Methods

    fetch

    • fetch(url, options?): Promise<Response>

    • fetch is a wrapper around the send method, instantiating a FetchCommand and then invoking the send method.

      Parameters

      • url: string | Request | URL
      • Optional options: RequestInit

      Returns Promise<Response>

    issuer

    • issuer(): Promise<URL>

    • A convenience accessor for obtaining the issuer URL from an oauth credential provider. The accessor will throw without properly instantiating an oauth credential provider.

      Returns Promise<URL>

    send

    terminalware

    • terminalware(this): FinalizeHandler<object, object>

    • A function that ends the middleware callback chain by executing fetch request and returning the response.

      between middlewares.

      Parameters

      • this: undefined

      Returns FinalizeHandler<object, object>

      A fetch Response object.

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcontextcredentialsloggermiddlewareprefixfetchissuersendterminalware