Class Organisms

Readonlykey

Readonlyname

addDependency

• addDependency(node): void

• Add a dependency to another node in the tree

  Parameters

  • node: INode

  Returns void

getDesignSystem

• getDesignSystem(): IDesignSystem

• Get the design system

  Returns IDesignSystem

getUninitializedRequiredProperties

• getUninitializedRequiredProperties(): string[]

• Return the keys of all properties which are required and not initialized.

  Returns string[]

  Returns the keys of all properties which are required and not initialized.

isEnabled

• isEnabled(): boolean

• Determine if this node is enabled. A node is enabled if all other nodes on which this node depends have been initialized.

  Returns boolean

  True if enabled, or false otherwise.

isInitialized

• isInitialized(): boolean

• Determine if this node is initialized.

  If this node is a property, it is initialized if it is not required to have a value, or if it is required and has either a default or non-default value.

  Returns boolean

  True if initialized, or false otherwise.

removeAllListeners

• removeAllListeners(): void

• Remove all listeners on this node.

  Returns void

removeListener

• removeListener(name): void

• Remove a listener by name.

  Parameters

  • name: string

    The name of the listener to remove

  Returns void

setListener

• setListener(name, callback, eventTypes?): ListenerSubscription

• Set a listener on this node

  Parameters

  • name: string

    The name of the listener.
  • callback: EventCallback

    The callback to call when an event occurs.
  • OptionaleventTypes: EventType[]

    The types of events to wait for. If none are specified, listen for all events.

  Returns ListenerSubscription

  The ListenerSubscription which should be canceled to stop listening.

store

• store(): Promise<void>

• Store persistently the state of the design system.

  Returns Promise<void>