Interface IEventClaims

The claim interface for an event store

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

Hierarchy (View Summary)

IEventClaims

Index

Methods

claim clearClaim isClaimed removeClaim touch unclaimed

Methods

claim

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

clearClaim

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

isClaimed

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

removeClaim

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

touch

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

unclaimed

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

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