Beignet API reference
    Preparing search index...

    Type Alias LeaseAcquireOptions

    Options for acquiring a lease.

    type LeaseAcquireOptions = {
        metadata?: LeaseMetadata;
        ownerToken?: string;
        retryDelayMs?: number;
        ttlMs: number;
        waitMs?: number;
    }
    Index
    metadata? ownerToken? retryDelayMs? ttlMs waitMs?
    metadata?: LeaseMetadata

    Optional diagnostics metadata. Providers should not use this for lock correctness.

    ownerToken?: string

    Optional owner token supplied by the caller. Providers generate one when omitted. Release and renew operations must only succeed for the current owner token.

    retryDelayMs?: number

    Delay between acquisition attempts while waiting.

    50
    ttlMs: number

    Lease time-to-live in milliseconds. The provider must treat ownership as expired after this duration unless the lease is renewed.

    waitMs?: number

    How long to wait for the lease before returning a non-acquired result.

    0

    Settings
    Member Visibility

    On This Page
    Properties