Class Registry<ItemT>

constructor

• new Registry<ItemT>(name, idField?, mode?): Registry<ItemT>

• Creates a new instance of the Registry class.

  Type Parameters

  • ItemT extends object = object

  Parameters

  • name: string

    The name of the registry.
  • Optional idField: string = 'id'

    The field to use as the ID of items in the registry.
  • Optional mode: RegistryModes = Registry.MODES.CLEAN

    The mode of the registry.

  Returns Registry<ItemT>

__banned

__idField

__mode

__name

__protected

__registered

__subscribers

__unregister

Static MODES

banned

• get banned(): string[]

• Gets the banned items in the registry.

  Returns string[]

  The banned item ids.

list

• get list(): ItemT[]

• Gets the list of items in the registry.

  Returns ItemT[]

  The items in the registry. This list only includes items that are currently active in the registry (i.e., not banned or unregistered).

listById

• get listById(): {
      [key: string]: ItemT;
  }

• Gets the list of items in the registry by ID.

  Returns {
      [key: string]: ItemT;
  }

  The items in the registry, indexed by ID. This list only includes items that are currently active in the registry (i.e., not banned or unregistered).

  • [key: string]: ItemT

mode

• get mode(): RegistryModes

• Gets the mode of the registry.

  Returns RegistryModes

  The mode of the registry. This will be one of the following: Registry.MODES.HISTORY, Registry.MODES.CLEAN.
• set mode(newMode): void

• Sets the mode of the registry.

  Parameters

  • newMode: RegistryModes

    The new mode. This should be one of the following: Registry.MODES.HISTORY, Registry.MODES.CLEAN. If it's not, the mode will be set to Registry.MODES.CLEAN.

  Returns void

protected

• get protected(): string[]

• Gets the protected items in the registry.

  Returns string[]

  The protected item ids.

registered

• get registered(): ItemT[]

• Gets the registered items in the registry.

  Returns ItemT[]

  The registered items. This includes all items that have been added to the registry, regardless of their status (banned or unregistered).

unregistered

• get unregistered(): string[]

• Gets the unregistered items in the registry.

  Returns string[]

  The unregistered item ids.

ban

• ban(id): Registry<ItemT>

• Bans an item in the registry.

  Parameters

  • id: any

    The ID of the item to ban.

  Returns Registry<ItemT>

  The registry instance.

  Emits

  Notification of type NotificationTypes.BAN When an item is banned.

  This method adds the item to the banned list. If the registry is in Registry.MODES.CLEAN mode, the cleanup method is also called to remove the item from the registry and perform any necessary cleanup operations.

cleanup

• cleanup(id): Registry<ItemT>

• Cleans up an item in the registry. Item is permanently removed.

  Parameters

  • id: any

    The ID of the item to clean up.

  Returns Registry<ItemT>

  The registry instance.

  Emits

  Notification of type NotificationTypes.CLEANUP When an item is cleaned up.

  This method is responsible for removing the item from the registry and performing any necessary cleanup operations. It is called when an item is unregistered and the registry is in Registry.MODES.CLEAN mode.

flush

• flush(): Registry<ItemT>

• Flushes the registry.

  Returns Registry<ItemT>

  The registry instance.

  Emits

  Notification of type NotificationTypes.FLUSH When the registry is flushed.

  This method is responsible for removing all items from the registry, clearing the protected, unregistered, and banned lists.

get

• get<T>(path, defaultValue?): undefined | ItemT | T

• Retrieves an item from the registry by its path.

  Type Parameters

  • T = any

    The expected return type.

  Parameters

  • path: Path

    The path of the item to retrieve. The first element of the path is the ID of the item.
  • Optional defaultValue: T

    The default value to return if the item does not exist.

  Returns undefined | ItemT | T

  The item with the given path, or the default value if no such item exists.

  See

  • Path
  • https://www.npmjs.com/package/object-path|object-path

isBanned

• isBanned(id): boolean

• Checks if an item is banned in the registry.

  Parameters

  • id: any

    The ID of the item to check.

  Returns boolean

  True if the item is banned, false otherwise.

isProtected

• isProtected(id): boolean

• Checks if an item is protected in the registry.

  Parameters

  • id: string

    The ID of the item to check.

  Returns boolean

  True if the item is protected, false otherwise.

isRegistered

• isRegistered(id): boolean

• Checks if an item is registered in the registry.

  Parameters

  • id: string

    The ID of the item to check.

  Returns boolean

  True if the item is registered, false otherwise.

isUnRegistered

• isUnRegistered(id): boolean

• Checks if an item is unregistered in the registry.

  Parameters

  • id: any

    The ID of the item to check.

  Returns boolean

  True if the item is unregistered, false otherwise.

notify

• notify(context): void

• Sends a notification to all subscribed callback functions.

  Parameters

  • context: Notification<ItemT>

    The notification to send.

  Returns void

  Emits

  Notification to all subscribed callback functions.

protect

• protect(id): Registry<ItemT>

• Protects an item in the registry from being unregistered.

  Parameters

  • id: string

    The ID of the item to protect.

  Returns Registry<ItemT>

  The registry instance.

  Emits

  Notification of type NotificationTypes.PROTECT When an item is protected.

register

• register(id, data): this

• Registers an item in the registry with the provided ID.

  Parameters

  • id: string

    The ID of the item to register.
  • data: ItemT

    The item to register.

  Returns this

  The registry instance.

  Throws

  If the item is banned or if a protected item is already registered.

  Emits

  Notification of type NotificationTypes.REGISTER When an item is registered.

• register(data): this

• Registers an item in the registry with an ID generated by the registry.

  Parameters

  • data: ItemT

    The item to register.

  Returns this

  The registry instance.

  Throws

  If the item is banned or if a protected item is already registered.

  Emits

  Notification of type NotificationTypes.REGISTER When an item is registered.

subscribe

• subscribe(cb, id?): (() => void)

• Subscribes a callback function to notifications from the registry.

  Parameters

  • cb: Subscriber<ItemT>

    The callback function to subscribe.
  • Optional id: string

    The ID to associate with the subscription. If not provided, a new UUID will be generated.

  Returns (() => void)

  A function that, when called, will unsubscribe the callback function from the registry.

  • • (): void

    • Returns void

unban

• unban(id): Registry<ItemT>

• Removes ban on an item in the registry.

  Parameters

  • id: any

    The ID of the item to ban.

  Returns Registry<ItemT>

  The registry instance.

  Emits

  Notification of type NotificationTypes.BAN When an item is banned.

  This method removes the item to the banned list.

unprotect

• unprotect(id): Registry<ItemT>

• Removes protection from an item in the registry.

  Parameters

  • id: string

    The ID of the item to unprotect.

  Returns Registry<ItemT>

  The registry instance.

  Emits

  Notification of type NotificationTypes.UNPROTECT When an item is unprotected.

unregister

• unregister(id): this

• Unregisters an item from the registry.

  Parameters

  • id: string

    The ID of the item to unregister.

  Returns this

  The registry instance.

  Throws

  If the item is protected.

  Emits

  Notification of type NotificationTypes.UNREGISTER When an item is unregistered.

  If the registry is in Registry.MODES.CLEAN, the item is immediately removed and the cleanup method is called. If the registry is in Registry.MODES.DEFAULT, the item is marked for unregistration but not immediately removed.

unsubscribe

• unsubscribe(id?): void

• Subscribes a callback function to notifications from the registry.

  Parameters

  • Optional id: string

    The ID to associate with the subscription. If not provided, a new UUID will be generated.

  Returns void

  A function that, when called, will unsubscribe the callback function from the registry.

unsubscribeAll

• unsubscribeAll(): void

• Subscribes a callback function to notifications from the registry.

  Returns void

  A function that, when called, will unsubscribe the callback function from the registry.