Documentation
    Preparing search index...

    Interface ClientOptions<Context>

    interface ClientOptions<
        Context extends ByuClientExecutionContext = ByuClientExecutionContext,
    > {
        context?: ClientMiddlewareExecutionContext & Context;
        credentials?: boolean | typeof CredentialProvider | CredentialProvider;
        endpoint?: EndpointDictionary;
        logger?: LoggerLike;
        prefix?: string;
        retry?: RetryMiddlewareConfiguration;
    }

    Type Parameters

    • Context extends ByuClientExecutionContext = ByuClientExecutionContext

    Hierarchy (View Summary)

    Index

    Properties

    context? credentials? endpoint? logger? prefix? retry?

    Properties

    context?: ClientMiddlewareExecutionContext & Context

    The initial middleware execution context

    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.

    endpoint?: EndpointDictionary
    logger?: LoggerLike

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

    prefix?: string

    The environment variable prefix to use to load the credential provider

    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

    On This Page

    Properties