@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface ClaimOptions

    Options of InboxJournal.claim / OutboxJournal.claimDue.

    interface ClaimOptions {
        owner: string;
        leaseMs: number;
        now: number;
        limit: number;
        reclaimOwn?: boolean;
        partitions?: (key: string) => boolean;
    }

    Hierarchy (View Summary)

    Index
    owner leaseMs now limit reclaimOwn? partitions?
    owner: string

    Who takes the lease.

    leaseMs: number

    Lease duration in ms.

    now: number

    Current time (epoch ms).

    limit: number

    Max records to claim.

    reclaimOwn?: boolean

    Also take records leased by owner itself whose lease has not expired yet: a restarted process with a stable instanceId reclaims what its previous incarnation left in flight, without waiting for the lease to expire.

    partitions?: (key: string) => boolean

    Only claim records whose partition (inbox) or chat (outbox) passes this filter (multi-replica ownership).

    Settings
    Member Visibility

    On This Page
    Properties