Interface ClientOptions<UserContext>

interface ClientOptions<UserContext> {
    context?: ClientMiddlewareExecutionContext & UserContext;
    credentials?: boolean | typeof CredentialProvider | CredentialProvider;
    logger?: Logger;
    prefix?: string;
    retry?: RetryMiddlewareConfiguration;
}

Type Parameters

  • UserContext extends object = object

Hierarchy

  • ClientOptions

    Properties

    context? credentials? logger? prefix? retry?

    Properties

    Optional context

    context?: ClientMiddlewareExecutionContext & UserContext

    The initial middleware execution context

    Optional credentials

    credentials?: boolean | typeof CredentialProvider | CredentialProvider

    A credential provider to use for resolving access tokens. The default credential provider is the ChainedCredentialsProvider. All credential provider inputs may be configured via environmental variables.

    Optional logger

    logger?: Logger

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

    Optional prefix

    prefix?: string

    The environment variable prefix to use to load the credential provider

    Optional retry

    retry?: RetryMiddlewareConfiguration

    Configures the retry middleware. The default configuration will attempt one retry when the response contains a 401 HTTP status code.

    Settings

    Member Visibility

    Theme

    On This Page

    contextcredentialsloggerprefixretry