Class OverrideClassRegistry<T>

constructor

• new OverrideClassRegistry<T extends AbstractCtor>(
      coreClassRegistry: ClassRegistry<T>,
  ): OverrideClassRegistry<T>

  Type Parameters

  • T extends AbstractCtor

  Parameters

  • coreClassRegistry: ClassRegistry<T>

  Returns OverrideClassRegistry<T>

create

• create(className: string, ...args: unknown[]): InstanceType<T> | undefined

  Create an object of the given className. The constructor is passed args.

  Parameters

  • className: string
  • ...args: unknown[]

  Returns InstanceType<T> | undefined

createFromTypeOptions

• createFromTypeOptions(
      options: { type?: string } & Record<string, unknown>,
      ...args: unknown[],
  ): InstanceType<T> | undefined

  A convenience API to pass in a serialized VcsObject directly. It calls create using options.type as the className. Will throw an error if options.type is not a string or options is not an Object. Passes options and args to the constructor in that order.

  Parameters

  • options: { type?: string } & Record<string, unknown>
  • ...args: unknown[]

  Returns InstanceType<T> | undefined

destroy

• destroy(): void

  Destroys the override class registry

  Returns void

getClass

• getClass(className: string): Ctor<T> | undefined

  Gets the constructor for a registered class or undefined, if no such class was registerd

  Parameters

  • className: string

  Returns Ctor<T> | undefined

getClassNames

• getClassNames(): string[]

  Returns string[]

hasClass

• hasClass(className: string): boolean

  Parameters

  • className: string

  Returns boolean

registerClass

• registerClass(moduleId: string, className: string, ctor: Ctor<T>): void

  Register a class for a given module by name. If the class already exists, it will be replaced and replaced called with the classeName.

  Parameters

  • moduleId: string
  • className: string
  • ctor: Ctor<T>

  Returns void

removeModule

• removeModule(moduleId: string): void

  Removes all classes registered from within a certain module. Will re-instate classes overwritten by the module and call the appropriate events, outlined in unregisterClass.

  Parameters

  • moduleId: string

  Returns void

unregisterClass

• unregisterClass(moduleId: string, className: string): void

  Unregister a previously registered class. You can only unregister classes added to this registry, not the underlying core registry. If when registering this class you have replaced class, it will be re-instated and replaced called. If there is no previously registered class, it will be removed and removed will be called.

  Parameters

  • moduleId: string
  • className: string

  Returns void

removed

replaced