Class Model<T>

Class representing a model.

Implements

IModelAdapter

Type Parameters

  • T extends {} = any

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

_data _debounce _dropChanges _prevData emit getListeners handleDropChanges once refresh subscribe toObject unsubscribe unsubscribeAll

Accessors

data hasListeners

Methods

handleChange setData

Constructors

constructor

Properties

Protected_data

_data: T

Protected_debounce

_debounce: number

Protected_dropChanges

_dropChanges: Subject<void>

Protected_prevData

_prevData: () => T

emit

emit: (eventName: EventKey, ...args: any[]) => Promise<void>

Emits the given event with the specified arguments.

Type declaration

    • (eventName: EventKey, ...args: any[]): Promise<void>

    • Parameters

      • eventName: EventKey

        The name of the event to emit.

      • ...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: EventKey) => Function[]

Retrieves the listeners associated with the given event key.

Type declaration

    • (key: EventKey): Function[]

    • Parameters

      • key: EventKey

        The event key to retrieve the listeners for.

      Returns Function[]

      An array of listeners associated with the given event key.

handleDropChanges

handleDropChanges: () => void

Handles the changes when an item is dropped.

Type declaration

    • (): void

    • Returns void

Function

handleDropChanges

Memberof

ClassName

once

once: (eventName: EventKey, callback: Function) => () => void

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

Type declaration

    • (eventName: EventKey, callback: Function): () => void

    • 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.

refresh

refresh: () => Promise<void>

A function that triggers a refresh event.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Function

Member Of

global

subscribe

subscribe: (eventName: EventKey, callback: Function) => void

Subscribes a callback function to the specified event name.

Type declaration

    • (eventName: EventKey, callback: Function): void

    • 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.

Type declaration

    • (): T

    • Returns T

      • The plain JavaScript object representation.

Function

unsubscribe

unsubscribe: (eventName: EventKey, callback: Function) => void

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

Type declaration

    • (eventName: EventKey, callback: Function): void

    • 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.

Type declaration

    • (): void

    • Returns void

Function

Accessors

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.

Methods

handleChange

  • handleChange(change: (item: Model<T>) => void): () => void

    Handles changes made to the Model.

    Parameters

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

      The callback function to be executed when a change occurs in the Model. It accepts a single parameter representing the changed item of type Model.

    Returns () => void

    • A cleanup function that unsubscribes the callback from the CHANGE_SYMBOL event, unsubscribes the callback from the REFRESH_SYMBOL event, clears the debounce function, and unsubscribes the drop function.

setData

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

    Sets the data for the object.

    Parameters

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

      The data to be set. It can be a partial object or a function that takes the previous data and returns a partial object.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods