useRegistry API
API reference for the useRegistry composable.
booleanEnable event emission for registry operations
Default: false
Map<ID, Z>The collection of tickets in the registry
numberThe number of tickets in the registry
() => voidClear the entire registry
(id: ID) => booleanCheck if a ticket exists by ID
() => ID[]Get all registered IDs
(value: unknown) => ID[] | undefinedBrowse for an ID(s) by value
(index: number) => ID | undefinedlookup a ticket by index number
(id: ID) => Z | undefinedGet a ticket by ID
(id: ID, ticket?: Partial<Z>) => ZUpdate or insert a ticket by ID
() => Z[]Get all values of registered tickets
() => [ID, Z][]Get all entries of registered tickets
(ticket?: Partial<Z>) => ZRegister a new ticket
(id: ID) => voidUnregister an ticket by ID
() => voidReset the index directory and update all tickets
(direction?: "first" | "last", from?: number, predicate?: (ticket) => boolean) => Z | undefinedSeek for a ticket based on direction and optional predicate
(event: string, cb: RegistryEventCallback) => voidListen for registry events
(event: string, cb: RegistryEventCallback) => voidStop listening for registry events
(event: string, data: unknown) => voidEmit an event with data
() => voidClears the registry and removes all listeners
(registrations: Partial<Z>[]) => Z[]Onboard multiple tickets at once
(ids: ID[]) => voidOffboard multiple tickets at once
<R>(fn: () => R) => RExecute operations in a batch, deferring cache invalidation and event emission until complete
