Class Client<UserContext>

constructor

• new Client<UserContext extends object = object>(
      options?: ClientOptions<UserContext>,
  ): Client<UserContext>

  A generic client constructor

  Type Parameters

  • UserContext extends object = object

  Parameters

  • options: ClientOptions<UserContext> = {}

    Options to configure the HTTP Client.

  Returns Client<UserContext>

Optional Readonlycredentials

Readonlymiddleware

Readonlyprefix

fetch

• fetch(url: string | Request | URL, options?: RequestInit): Promise<Response>

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

  Parameters

  • url: string | Request | URL
  • Optionaloptions: 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>

request

• request(
      ...args: [
          url: string
          | RequestInput,
          options?: RequestPromiseOptions & OptionalUriUrl,
      ],
  ): Promise<RequestOutput>

  Parameters

  • ...args: [url: string | RequestInput, options?: RequestPromiseOptions & OptionalUriUrl]

  Returns Promise<RequestOutput>

send

• send<I extends object, O extends object>(
      command: Command<I, O, ClientMiddlewareExecutionContext & UserContext>,
  ): Promise<O>

  Enchains the middleware stack executes the asynchronous operation

  Type Parameters

  • I extends object
  • O extends object

  Parameters

  • command: Command<I, O, ClientMiddlewareExecutionContext & UserContext>

    A action that represents the parameters needed to call a specific endpoint or perform some asynchronous sequence of work.

  Returns Promise<O>

  The fully deserialized value.

terminalware

• terminalware(this: undefined): 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.