Documentation
    Preparing search index...

    Interface PersonsClientOptions

    interface PersonsClientOptions {
        context?: ClientMiddlewareExecutionContext & PersonsMiddlewareExecutionContext;
        credentials?: boolean | CredentialProvider | typeof CredentialProvider;
        logger?: LoggerLike;
        prefix?: string;
        retry?: RetryMiddlewareConfiguration;
    }

    Hierarchy (View Summary)

    • ClientOptions<PersonsMiddlewareExecutionContext>
      • PersonsClientOptions
    Index

    Properties

    context?: ClientMiddlewareExecutionContext & PersonsMiddlewareExecutionContext

    The initial middleware execution context

    credentials?: boolean | CredentialProvider | typeof 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.

    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

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