Interface IEventClaims<E>

The claim interface for an event store

interface IEventClaims<E extends StoreEvent = NostrEvent> {
    claim(event: E): void;
    clearClaim(event: E): void;
    isClaimed(event: E): boolean;
    removeClaim(event: E): void;
    touch(event: E): void;
    unclaimed(): Generator<E>;
}

Type Parameters

E extends StoreEvent = NostrEvent

Hierarchy (View Summary)

IEventClaims

Index

Methods

claim clearClaim isClaimed removeClaim touch unclaimed

Methods

claim

claim(event: E): void
Increments the claim count on the event
Parameters
- event: E
Returns void
- Defined in packages/core/src/event-store/interface.ts:116

clearClaim

clearClaim(event: E): void
Removes all claims on an event
Parameters
- event: E
Returns void
- Defined in packages/core/src/event-store/interface.ts:122

isClaimed

isClaimed(event: E): boolean
Checks if an event is claimed by anything
Parameters
- event: E
Returns boolean
- Defined in packages/core/src/event-store/interface.ts:118

removeClaim

removeClaim(event: E): void
Decrements the claim count on an event
Parameters
- event: E
Returns void
- Defined in packages/core/src/event-store/interface.ts:120

touch

touch(event: E): void
Tell the store that this event was used
Parameters
- event: E
Returns void
- Defined in packages/core/src/event-store/interface.ts:114

unclaimed

unclaimed(): Generator<E>
Returns a generator of unclaimed events in order of least used

Returns Generator<E>
- Defined in packages/core/src/event-store/interface.ts:124