Interface SarrafOptions<P>

interface SarrafOptions<P extends ProvidersConfig = ProvidersConfig> {
    allowBeta?: boolean;
    debug?: boolean;
    http?: HttpClientOptions | HttpClient;
    idempotency?: IdempotencyStore;
    idempotencyTtlSeconds?: number;
    logger?: Logger;
    now?: () => Date;
    providers: P;
}

Type Parameters

P extends ProvidersConfig = ProvidersConfig

Index

Properties

allowBeta? debug? http? idempotency? idempotencyTtlSeconds? logger? now? providers

Properties

`Optional`allowBeta

allowBeta?: boolean

Allow calling capabilities marked "beta". Default false.

`Optional`debug

debug?: boolean

Log redacted requests and responses.

`Optional`http

http?: HttpClientOptions | HttpClient

`Optional`idempotency

idempotency?: IdempotencyStore

Defaults to an in-memory store. Use RedisStore from @sarrafjs/core/redis across instances.

`Optional`idempotencyTtlSeconds

idempotencyTtlSeconds?: number

How long completed idempotent results are kept. Default 24h.

`Optional`logger

logger?: Logger

`Optional`now

now?: () => Date

providers

providers: P