Interface IModuleApi

_apiId

addEventListener

• addEventListener<K extends never>(
      eventType: K,
      listener: EventHandler<{}, K>,
  ): DisposeListener

  Adds an event listener for the specified event type.

  Type Parameters

  • K extends never

  Parameters

  • eventType: K

    The type of event to listen for.
  • listener: EventHandler<{}, K>

    The event listener to add.

  Returns DisposeListener

  A function that can be called to remove the event listener.

addModule

• addModule(name: string): Promise<Readonly<Module>>

  Creates a new module.

  Parameters

  • name: string

    The name of the new module.

  Returns Promise<Readonly<Module>>

  Promise resolving to the created module.

deleteModule

• deleteModule(name: string, allowNonEmptyDeletion?: boolean): Promise<void>

  Deletes a module by its name.

  Parameters

  • name: string

    The name of the module to delete.
  • OptionalallowNonEmptyDeletion: boolean

    Flag indicating whether to force deletion of non-empty modules.

  Returns Promise<void>

  Promise that resolves when the module is deleted.

getModule

• getModule(name: string): Promise<null | Readonly<Module>>

  Retrieves a specific module by its name.

  Parameters

  • name: string

    The name of the module to retrieve.

  Returns Promise<null | Readonly<Module>>

  Promise resolving to the module if found, or null otherwise.

getModules

• getModules(): Promise<readonly Readonly<Module>[]>

  Retrieves all modules in the model.

  Returns Promise<readonly Readonly<Module>[]>

  Promise resolving to a readonly array of modules.

removeEventListener

• removeEventListener<K extends never>(
      eventType: K,
      listener: EventHandler<{}, K>,
  ): void

  Removes an event listener for the specified event type.

  Type Parameters

  • K extends never

  Parameters

  • eventType: K

    The type of event to remove the listener from.
  • listener: EventHandler<{}, K>

    The event listener to remove.

  Returns void