Documentation
    Preparing search index...

    Class IdentitiesClient

    Hierarchy (View Summary)

    • Client<IdentitiesMiddlewareExecutionContext>
      • IdentitiesClient
    Index

    Constructors

    Properties

    context: MiddlewareExecutionContext<
        ClientMiddlewareExecutionContext & IdentitiesMiddlewareExecutionContext,
    >

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

    credentials?: CredentialProvider

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

    logger: LoggerLike

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

    middleware: MiddlewareStack<
        any,
        any,
        MiddlewareExecutionContext<
            ClientMiddlewareExecutionContext & IdentitiesMiddlewareExecutionContext,
        >,
    >

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

    prefix: string

    Expose the prefix for other extensions to match with.

    Methods

    • 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>

    • 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>

    • Parameters

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

      Returns Promise<RequestOutput>

    • Enchains the middleware stack executes the asynchronous operation

      Type Parameters

      • I extends object
      • O extends object

      Parameters

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

        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.

    • 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.