Class EntityBase

EntityBase.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_app? _destroyed data extData instanceId moduleManager onSetApp options uuid

Accessors

app destroyed modules uiConfig

Methods

add addDispose addModule applyMixinsTo callModules destroy dispatch effectScope eventNames getModule hasEvent listenerCount off on once removeAllEventListeners removeAllModules removeDispose removeModule

Constructors

constructor

Properties

Optional _app

_app?: App

Protected _destroyed

_destroyed: boolean = false

data

data: ShallowReactive<{
    [key: string]: any;
}> = ...

Type declaration

  • [key: string]: any

extData

extData: {
    [key: string]: any;
} = {}

Type declaration

  • [key: string]: any

Readonly instanceId

instanceId: number = ++AppObject._instanceIdCounter

Readonly moduleManager

moduleManager: ModuleManager = ...

onSetApp

onSetApp: Signal = ...

options

options: EntityBaseOptions

uuid

uuid: string = ...

Accessors

app

  • get app(): App

  • Returns App

  • set app(value): void

  • Parameters

    Returns void

destroyed

  • get destroyed(): boolean

  • Whether it has been destroyed.

    Returns boolean

modules

uiConfig

Methods

add

  • add<T, U>(type, params?): T

  • 增加模块,如果模块已存在，则返回之前的模型，等同于this.addModule(xxx)

    Type Parameters

    Parameters

    • type: (new (entity?, obj?) => T)
        • new (entity?, obj?): T

        • Parameters

          • Optional entity: any
          • Optional obj: U

          Returns T

    • Optional params: U

    Returns T

addDispose

addModule

  • addModule<T, U>(type, params?): T

  • 增加模块,如果模块已存在，则返回之前的模型，等同于this.add(xxx)

    Type Parameters

    Parameters

    • type: (new (entity?, obj?) => T)

      模块类

        • new (entity?, obj?): T

        • Parameters

          • Optional entity: any
          • Optional obj: U

          Returns T

    • Optional params: U

      参数

    Returns T

applyMixinsTo

  • applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void

  • Parameters

    • toClassInst: any
    • Optional methodNames: string[]
    • Optional addMethods: string[]
    • Optional filterName: string[]

    Returns void

callModules

  • callModules(methodName, ...args): void

  • 调用模块中的函数

    Parameters

    • methodName: string
    • Rest ...args: any

    Returns void

destroy

dispatch

  • dispatch(event, ...data): boolean

  • 触发指定事件名称.

    Parameters

    • event: string

      Event name

    • Rest ...data: any

      Data

    Returns boolean

    • Whether the dispatching is successful

effectScope

  • effectScope(fn): void

  • Parameters

    • fn: (() => any)
        • (): any

        • Returns any

    Returns void

eventNames

  • eventNames(): string[]

  • 返回注册的所有事件名.

    Returns string[]

    所有事件名

getModule

  • getModule<T, U>(type): T

  • 获取模块

    Type Parameters

    Parameters

    • type: (new (entity?, obj?) => T)

      模型类型

        • new (entity?, obj?): T

        • Parameters

          • Optional entity: any
          • Optional obj: U

          Returns T

    Returns T

hasEvent

  • hasEvent(event): boolean

  • 确定是否存在事件侦听

    Parameters

    • event: string

      事件名

    Returns boolean

    返回是否存在相应的事件

listenerCount

  • listenerCount(event): number

  • 返回具有指定事件名称的侦听总数.

    Parameters

    • event: string

      Event name

    Returns number

    The count of listeners

off

  • off(event, fn?): EventDispatcher

  • 移除监听.

    Parameters

    • event: string

      Event name

    • Optional fn: Function

      Function, If is undefined, delete all corresponding event listeners.

    Returns EventDispatcher

on

once

removeAllEventListeners

  • removeAllEventListeners(event?): void

  • 通过事件名移除所有监听.

    Parameters

    • Optional event: string

      Event name, delete all events if not passed

    Returns void

removeAllModules

  • removeAllModules(): void

  • 移除所有模块

    Returns void

removeDispose

removeModule

  • removeModule<T, U>(type): void

  • 移除模块

    Type Parameters

    Parameters

    • type: (new (entity?, obj?) => T)

      模型类型

        • new (entity?, obj?): T

        • Parameters

          • Optional entity: any
          • Optional obj: U

          Returns T

    Returns void

Settings

Member Visibility

Theme

On This Page