Class OverrideClassRegistry<T>

constructor

• new OverrideClassRegistry<T>(coreClassRegistry): OverrideClassRegistry<T>

• Type Parameters

  • T extends AbstractCtor

  Parameters

  • coreClassRegistry: ClassRegistry<T>

  Returns OverrideClassRegistry<T>

create

• create(className, ...args): undefined | InstanceType<T>

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

  Parameters

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

  Returns undefined | InstanceType<T>

createFromTypeOptions

• createFromTypeOptions(options, ...args): undefined | InstanceType<T>

• 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>
  • Rest...args: unknown[]

  Returns undefined | InstanceType<T>

destroy

• destroy(): void

• Destroys the override class registry

  Returns void

getClass

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

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

  Parameters

  • className: string

  Returns undefined | Ctor<T>

getClassNames

• getClassNames(): string[]

• Returns string[]

hasClass

• hasClass(className): boolean

• Parameters

  • className: string

  Returns boolean

registerClass

• registerClass(moduleId, className, ctor): 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): 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, className): 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