Beignet API reference
    Preparing search index...

    Type Alias LeaseHandle

    Active lease handle returned by a lock provider.

    type LeaseHandle = {
        expiresAt?: Date;
        fencingToken?: string | number;
        key: string;
        ownerToken: string;
        release(): Promise<boolean>;
        renew(options?: LeaseRenewOptions): Promise<boolean>;
    }
    Index
    expiresAt? fencingToken? key ownerToken
    release renew
    expiresAt?: Date
    fencingToken?: string | number

    Optional monotonically increasing token. Apps can store this with writes to reject stale lease owners when the underlying resource supports fencing.

    key: string
    ownerToken: string

    • Returns Promise<boolean>

    • Parameters

      Returns Promise<boolean>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods