Interface IEventClaims

The claim interface for an event store

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

Hierarchy (View Summary)

IEventClaims

Index

Methods

claim clearClaim isClaimed removeClaim touch unclaimed

Methods

claim

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

clearClaim

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

isClaimed

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

removeClaim

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

touch

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

unclaimed

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

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