Class Entity<T>

Description

MVVM Object wrapper. Emmits change after setData

Type Parameters

  • T extends IEntity = any

Hierarchy (view full)

Implements

  • IEntityAdapter<T>

Constructors

constructor

Properties

_data _debounce _dropChanges _prevData

Accessors

data hasListeners id

Methods

emit getListeners handleChange handleDropChanges once refresh setData subscribe toObject unsubscribe unsubscribeAll

Constructors

constructor

  • new Entity<T>(_data, _debounce?, _prevData?): Entity<T>

  • Type Parameters

    • T extends IEntity = any

    Parameters

    • _data: Entity<T> | T | (() => T)
    • _debounce: number = CHANGE_DEBOUNCE
    • _prevData: (() => T) = ...
        • (): T

        • Returns T

    Returns Entity<T>

Properties

Protected_data

_data: T

Protected_debounce

_debounce: number = CHANGE_DEBOUNCE

Protected_dropChanges

_dropChanges: Subject<void> = ...

Protected_prevData

_prevData: (() => T) = ...

Accessors

data

  • get data(): T

  • Retrieves the value of the data property.

    Returns T

    The frozen data.

hasListeners

  • get hasListeners(): boolean

  • Check if the object has any listeners attached to it.

    Returns boolean

    True if the object has listeners, false otherwise.

id

  • get id(): string | number

  • Retrieves the id value from the data object.

    Returns string | number

    The id value.

Methods

emit

  • emit(eventName, ...args): Promise<void>

  • Emits the given event with the specified arguments.

    Parameters

    • eventName: EventKey

      The name of the event to emit.

    • Rest...args: any[]

      The arguments to pass to the event listeners.

    Returns Promise<void>

    • A promise that resolves when all event listeners have completed.

getListeners

  • getListeners(key): Function[]

  • Retrieves the listeners associated with the given event key.

    Parameters

    • key: EventKey

      The event key to retrieve the listeners for.

    Returns Function[]

    An array of listeners associated with the given event key.

handleChange

  • handleChange(change): (() => void)

  • Handles change events.

    Parameters

    • change: ((item: Entity<T>) => void)

      The change event handler function.

        • (item): void

        • Parameters

          Returns void

    Returns (() => void)

    • The function to unregister the change event.
      • (): void

      • Returns void

handleDropChanges

  • handleDropChanges(): void

  • Handles the changes when an item is dropped.

    Returns void

    Function

    handleDropChanges

    Memberof

    ClassName

once

  • once(eventName, callback): (() => void)

  • Subscribes a callback function to the given event name. The callback function will be triggered only once when the event is emitted.

    Parameters

    • eventName: EventKey

      The name of the event to subscribe to.

    • callback: Function

      The callback function to be executed when the event is emitted.

    Returns (() => void)

    • A function that can be called to unsubscribe the callback function from the event.
      • (): void

      • Returns void

refresh

  • refresh(): Promise<void>

  • A function that triggers a refresh event.

    Returns Promise<void>

    Function

    Member Of

    global

setData

  • setData(data): void

  • Sets the data for the given variable.

    Parameters

    • data: Partial<T> | ((prevData: T) => Partial<T>)

      The data to be set. This can either be a partial object of type T or a function that takes the previous data of type T and returns a partial object of type T.

    Returns void

subscribe

  • subscribe(eventName, callback): void

  • Subscribes a callback function to the specified event name.

    Parameters

    • eventName: EventKey

      The key of the event.

    • callback: Function

      The callback function to be executed when the event is triggered.

    Returns void

toObject

  • toObject(): T

  • Converts the object into a plain JavaScript object.

    Returns T

    • The plain JavaScript object representation.

    Function

unsubscribe

  • unsubscribe(eventName, callback): void

  • Removes a callback function from the list of event listeners for the specified event.

    Parameters

    • eventName: EventKey

      The key of the event to unsubscribe from.

    • callback: Function

      The callback function to remove from the event listeners.

    Returns void

unsubscribeAll

  • unsubscribeAll(): void

  • Clears all event handlers registered for the current object.

    Returns void

    Function

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods