Class TurboModel<DataType, KeyType, IdType, BlocksType, BlockType>

TurboModel

Description

A base class representing a model in MVC, which manages one or more data blocks and handles change propagation.

Type Parameters

DataType = any
The type of the data stored in each block.
KeyType extends string | number | symbol = any
The type of the keys used to access data in blocks.
IdType extends string | number | symbol = any
The type of the block IDs.
BlocksType extends "array" | "map" = "array" | "map"
Whether data blocks are stored as an array or a map.
BlockType extends TurboDataBlock<DataType, KeyType, IdType> = TurboDataBlock<DataType, KeyType, IdType>
The structure of each data block.

Implements

DataBlockHost<DataType, KeyType, IdType>

Constructors

constructor

new TurboModel<
    DataType = any,
    KeyType extends string | number | symbol = any,
    IdType extends string | number | symbol = any,
    BlocksType extends "map" | "array" = "map" | "array",
    BlockType extends
        TurboDataBlock<DataType, KeyType, IdType, any, any> = TurboDataBlock<
        DataType,
        KeyType,
        IdType,
        any,
        any,
    >,
>(
    data?: DataType,
    dataBlocksType?: BlocksType,
): TurboModel<DataType, KeyType, IdType, BlocksType, BlockType>
Type Parameters
- DataType = any
- KeyType extends string | number | symbol = any
- IdType extends string | number | symbol = any
- BlocksType extends "map" | "array" = "map" | "array"
- BlockType extends TurboDataBlock<DataType, KeyType, IdType, any, any> = TurboDataBlock<DataType, KeyType, IdType, any, any>
Parameters
- Optionaldata: DataType
  Initial data. Not initialized if provided.
- OptionaldataBlocksType: BlocksType
  Type of data blocks (array or map).
Returns TurboModel<DataType, KeyType, IdType, BlocksType, BlockType>
- Defined in src/mvc/core/model.ts:55

Properties

`Protected` `Readonly`isDataBlocksArray

isDataBlocksArray: boolean = false

`Protected` `Readonly`dataBlocks

dataBlocks: MvcBlocksType<BlocksType, BlockType>

handlers

handlers: Map<
    string,
    TurboHandler<
        TurboModel<
            any,
            any,
            any,
            "map"
            | "array",
            TurboDataBlock<any, any, any, any, any>,
        >,
    >,
>

Description

Map of MVC handlers bound to this model.

keyChangedCallback

keyChangedCallback: Delegate<
    (
        keyName: KeyType,
        blockKey: MvcBlockKeyType<BlocksType>,
        ...args: any[],
    ) => void,
>

Description

Delegate triggered when a key changes.

Accessors

block

get block(): BlockType
Returns BlockType
Description
The default block.
- Defined in src/mvc/core/model.ts:73
set block(value: BlockType): void
Parameters
- value: BlockType
Returns void
- Defined in src/mvc/core/model.ts:77

data

get data(): DataType
Returns DataType
Description
The data of the default block.
- Defined in src/mvc/core/model.ts:84
set data(value: DataType): void
Parameters
- value: DataType
Returns void
- Defined in src/mvc/core/model.ts:88

dataId

get dataId(): IdType
Returns IdType
Description
The ID of the default block.
- Defined in src/mvc/core/model.ts:95
set dataId(value: IdType): void
Parameters
- value: IdType
Returns void
- Defined in src/mvc/core/model.ts:99

enabledCallbacks

set enabledCallbacks(value: boolean): void
Parameters
- value: boolean
Returns void
Description
Whether callbacks are enabled or not.
- Defined in src/mvc/core/model.ts:106

defaultBlockKey

get defaultBlockKey(): MvcBlockKeyType<BlocksType>
Returns MvcBlockKeyType<BlocksType>
Description
The default block key based on whether the data structure is an array or map.
- Defined in src/mvc/core/model.ts:364

`Protected`defaultComputationBlockKey

get defaultComputationBlockKey(): MvcBlockKeyType<BlocksType>
Returns MvcBlockKeyType<BlocksType>
Description
The default block key if there's only one block, otherwise null.
- Defined in src/mvc/core/model.ts:371

Methods

onDirty

onDirty(key: KeyType, block: TurboDataBlock<DataType, KeyType, IdType>): void
Parameters
- key: KeyType
- block: TurboDataBlock<DataType, KeyType, IdType>
Returns void
Implementation of DataBlockHost.onDirty
- Defined in src/mvc/core/model.ts:42

onChange

onChange(
    key: KeyType,
    value: unknown,
    block: TurboDataBlock<DataType, KeyType, IdType>,
): void
Parameters
- key: KeyType
- value: unknown
- block: TurboDataBlock<DataType, KeyType, IdType>
Returns void
Implementation of DataBlockHost.onChange
- Defined in src/mvc/core/model.ts:46

getBlock

getBlock(blockKey?: MvcBlockKeyType<BlocksType>): BlockType
Function
getBlock
Parameters
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block key to retrieve.
Returns BlockType
The block or null if it doesn't exist.

Description
Retrieves the data block for the given blockKey.
- Defined in src/mvc/core/model.ts:116

`Protected`createBlock

createBlock(value: DataType | BlockType, id?: IdType): BlockType
Protected Function
createBlock
Parameters
- value: DataType | BlockType
  The data of the block.
- Optionalid: IdType
  The optional ID of the data.
Returns BlockType
- The created block.
Description
Creates a data block entry.
- Defined in src/mvc/core/model.ts:137

setBlock

setBlock(
    value: DataType | BlockType,
    id?: IdType,
    blockKey?: MvcBlockKeyType<BlocksType>,
    initialize?: boolean,
): void
Function
setBlock
Parameters
- value: DataType | BlockType
  The data to set.
- Optionalid: IdType
  Optional block ID.
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The key of the block.
- Optionalinitialize: boolean = true
  Whether to initialize the block after setting.
Returns void
Description
Creates and sets a data block at the specified key.
- Defined in src/mvc/core/model.ts:151

hasBlock

hasBlock(blockKey?: MvcBlockKeyType<BlocksType>): boolean
Function
hasBlock
Parameters
- OptionalblockKey: MvcBlockKeyType<BlocksType>
  Block key.
Returns boolean
- Whether the block exists or not.
Description
Check if a block exists at the given key.
- Defined in src/mvc/core/model.ts:182

deleteBlock

deleteBlock(blockKey: MvcBlockKeyType<BlocksType>): void
Parameters
- blockKey: MvcBlockKeyType<BlocksType>
Returns void
- Defined in src/mvc/core/model.ts:190

addBlock

addBlock(
    value: DataType | BlockType,
    id?: IdType,
    blockKey?: MvcBlockKeyType<BlocksType>,
    initialize?: boolean,
): void
Function
addBlock
Parameters
- value: DataType | BlockType
  The block data.
- Optionalid: IdType
  Optional block ID.
- OptionalblockKey: MvcBlockKeyType<BlocksType>
  Block key (used for insertion in arrays).
- Optionalinitialize: boolean = true
  Whether to initialize after adding.
Returns void
Description
Adds a new block into the structure. Appends or inserts based on key if using array.
- Defined in src/mvc/core/model.ts:213

getData

getData(key: KeyType, blockKey?: MvcBlockKeyType<BlocksType>): unknown
Function
getData
Parameters
- key: KeyType
  The key to retrieve.
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block from which to retrieve the data.
Returns unknown
The value associated with the key, or null if not found.

Description
Retrieves the value associated with a given key in the specified block.
- Defined in src/mvc/core/model.ts:232

setData

setData(
    key: KeyType,
    value: unknown,
    blockKey?: MvcBlockKeyType<BlocksType>,
): void
Function
setData
Parameters
- key: KeyType
  The key to update.
- value: unknown
  The value to assign.
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block to update.
Returns void
Description
Sets the value for a given key in the specified block and triggers callbacks (if enabled).
- Defined in src/mvc/core/model.ts:243

hasData

hasData(key: KeyType, blockKey?: MvcBlockKeyType<BlocksType>): boolean
Function
hasData
Parameters
- key: KeyType
  The key to update.
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block to update.
Returns boolean
Description
Sets the value for a given key in the specified block and triggers callbacks (if enabled).
- Defined in src/mvc/core/model.ts:253

deleteData

deleteData(key: KeyType, blockKey?: MvcBlockKeyType<BlocksType>): void
Parameters
- key: KeyType
- blockKey: MvcBlockKeyType<BlocksType> = ...
Returns void
- Defined in src/mvc/core/model.ts:257

getSize

getSize(blockKey?: MvcBlockKeyType<BlocksType>): number
Function
getSize
Parameters
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block to check.
Returns number
The size.

Description
Returns the size of the specified block.
- Defined in src/mvc/core/model.ts:267

toJSON

toJSON(blockKey?: MvcBlockKeyType<BlocksType>): object
Parameters
- blockKey: MvcBlockKeyType<BlocksType> = ...
Returns object
- Defined in src/mvc/core/model.ts:271

getBlockData

getBlockData(blockKey?: MvcBlockKeyType<BlocksType>): DataType
Function
getBlockData
Parameters
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block key.
Returns DataType
The block's data or if it doesn't exist.

Description
Retrieves the data from a specific block.
- Defined in src/mvc/core/model.ts:281

getBlockId

getBlockId(blockKey?: MvcBlockKeyType<BlocksType>): IdType
Function
getBlockId
Parameters
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block key.
Returns IdType
The block ID or null.

Description
Retrieves the ID from a specific block.
- Defined in src/mvc/core/model.ts:291

setBlockId

setBlockId(value: IdType, blockKey?: MvcBlockKeyType<BlocksType>): void
Function
setBlockId
Parameters
- value: IdType
  The new ID.
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block key.
Returns void
Description
Sets the ID for a specific block.
- Defined in src/mvc/core/model.ts:301

`Protected`fireCallback

fireCallback(key: string | KeyType, ...args: any[]): void
Function
fireCallback
Parameters
- key: string | KeyType
  The key to fire for.
- ...args: any[]
  Additional arguments.
Returns void
Description
Fires the emitter's change callback for the given key in the default blocks.
- Defined in src/mvc/core/model.ts:326

`Protected`fireBlockCallback

fireBlockCallback(
    key: string | KeyType,
    blockKey?: MvcBlockKeyType<BlocksType>,
    ...args: any[],
): void
Function
fireBlockCallback
Parameters
- key: string | KeyType
  The key to fire for.
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block key.
- ...args: any[]
  Additional arguments.
Returns void
Description
Fires the emitter's change callback for the given key in a specific block with custom arguments.
- Defined in src/mvc/core/model.ts:337

initialize

initialize(blockKey?: MvcBlockKeyType<BlocksType>): void
Function
initialize
Parameters
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block key.
Returns void
Description
Initializes the block at the given key, and triggers callbacks for all the keys in its data.
- Defined in src/mvc/core/model.ts:347

clear

clear(clearData?: boolean, blockKey?: MvcBlockKeyType<BlocksType>): void
Function
clear
Parameters
- clearData: boolean = true
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block key.
Returns void
Description
Clears the block data at the given key.
- Defined in src/mvc/core/model.ts:357

`Protected`isValidBlockKey

isValidBlockKey(blockKey: MvcBlockKeyType<BlocksType>): boolean
Function
isValidBlockKey
Parameters
- blockKey: MvcBlockKeyType<BlocksType>
  The block key to validate.
Returns boolean
True if valid, false otherwise.

Description
Checks if the block key is a valid string or number.
- Defined in src/mvc/core/model.ts:384

getAllBlockKeys

getAllBlockKeys(): MvcBlockKeyType<BlocksType>[]
Function
getAllBlockKeys

Returns MvcBlockKeyType<BlocksType>[]
Array of block keys.

Description
Retrieves all block keys in the model.
- Defined in src/mvc/core/model.ts:395

getAllBlockIds

getAllBlockIds(): IdType[]
Function
getAllBlockIds

Returns IdType[]
Array of IDs.

Description
Retrieves all block (data) IDs in the model.
- Defined in src/mvc/core/model.ts:405

getAllBlocks

getAllBlocks(blockKey?: MvcBlockKeyType<BlocksType>): BlockType[]
Function
getAllBlocks
Parameters
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block key.
Returns BlockType[]
Array of blocks.

Description
Retrieves all blocks or a specific one if blockKey is defined.
- Defined in src/mvc/core/model.ts:415

getBlockKey

getBlockKey(
block: TurboDataBlock<DataType, KeyType, IdType>,
): MvcBlockKeyType<BlocksType>
Parameters
- block: TurboDataBlock<DataType, KeyType, IdType>
Returns MvcBlockKeyType<BlocksType>
- Defined in src/mvc/core/model.ts:431

getAllKeys

getAllKeys(blockKey?: MvcBlockKeyType<BlocksType>): KeyType[]
Function
getAllKeys
Parameters
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block key.
Returns KeyType[]
Array of keys.

Description
Retrieves all keys within the given block(s).
- Defined in src/mvc/core/model.ts:443

getAllValues

getAllValues(blockKey?: MvcBlockKeyType<BlocksType>): unknown[]
Function
getAllValues
Parameters
- OptionalblockKey: MvcBlockKeyType<BlocksType> = ...
  The block key.
Returns unknown[]
Array of values.

Description
Retrieves all values across block(s).
- Defined in src/mvc/core/model.ts:453

getHandler

getHandler(key: string): TurboHandler
Function
getHandler
Parameters
- key: string
  The handler's key.
Returns TurboHandler
- The handler.
Description
Retrieves the attached MVC handler with the given key. By default, unless manually defined in the handler, if the element's class name is MyElement and the handler's class name is MyElementSomethingHandler, the key would be "something".
- Defined in src/mvc/core/model.ts:465

addHandler

addHandler(handler: TurboHandler): void
Function
addHandler
Parameters
- handler: TurboHandler
  The handler instance to register.
Returns void
Description
Registers a TurboHandler for the given key.
- Defined in src/mvc/core/model.ts:474

Class TurboModel<DataType, KeyType, IdType, BlocksType, BlockType>

Description

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TurboModel<DataType, KeyType, IdType, BlocksType, BlockType>

Properties

Protected ReadonlyisDataBlocksArray

Protected ReadonlydataBlocks

handlers

Description

keyChangedCallback

Description

Accessors

block

Returns BlockType

Description

Parameters

Returns void

data

Returns DataType

Description

Parameters

Returns void

dataId

Returns IdType

Description

Parameters

Returns void

enabledCallbacks

Parameters

Returns void

Description

defaultBlockKey

Returns MvcBlockKeyType<BlocksType>

Description

ProtecteddefaultComputationBlockKey

Returns MvcBlockKeyType<BlocksType>

Description

Methods

onDirty

Parameters

Returns void

onChange

Parameters

Returns void

getBlock

Parameters

Returns BlockType

Description

ProtectedcreateBlock

Parameters

Returns BlockType

Description

setBlock

Parameters

Returns void

Description

hasBlock

Parameters

Returns boolean

Description

deleteBlock

Parameters

Returns void

addBlock

Parameters

Returns void

Description

getData

Parameters

Returns unknown

`Protected` `Readonly`isDataBlocksArray

`Protected` `Readonly`dataBlocks

`Protected`defaultComputationBlockKey

`Protected`createBlock

`Protected`fireCallback

`Protected`fireBlockCallback

`Protected`isValidBlockKey