Setu-TS
    Preparing search index...

    Interface IdempotentWithinOptions

    Options for IIdempotencyService.within: the key, what it is for, the isolation segment, and the request fingerprint.

    0.9.0

    interface IdempotentWithinOptions {
        fingerprint?: unknown;
        key: string;
        namespace: string;
        scope: string;
        ttlMs?: number;
    }
    Index
    fingerprint? key namespace scope ttlMs?
    fingerprint?: unknown

    Any canonical-JSON value describing the request; a different value under one key is refused. Default: none.

    key: string

    The client's key: 1–255 characters of 0x21–0x7E, no ".

    namespace: string

    What the key is for, e.g. 'payments.charge'. 1–256 characters of 0x20–0x7E.

    scope: string

    REQUIRED isolation segment, built ONLY from authenticated identity — typically JSON.stringify([tenantId, principalId]). Do not join parts with a separator that can appear inside them: distinct identities can collide. '' declares the record global on purpose. Never derived for the caller: within has no request context.

    ttlMs?: number

    Default: the plugin's transactional.ttlMs (86,400,000). Integer 60,000–2,592,000,000.

    Settings
    Member Visibility

    On This Page
    Properties