Class Client<UserContext>

constructor

• new Client<UserContext>(options?): 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 Readonly credentials

Readonly middleware

Readonly prefix

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>

request

• request(...args): Promise<RequestOutput>

• Parameters

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

  Returns Promise<RequestOutput>

send

• send<I, O>(command): 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): 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.