Class TurboYBlock<YType, KeyType, IdType>

Type Parameters

YType extends YMap | YArray = YMap | YArray
KeyType extends string | number | symbol = any
IdType extends string | number | symbol = any

Hierarchy (View Summary)

TurboDataBlock<YType, KeyType, IdType>
- TurboYBlock

Index

Constructors

constructor

new TurboYBlock<
    YType extends YMap<any>
    | YArray<any> = YMap<any> | YArray<any>,
    KeyType extends string | number | symbol = any,
    IdType extends string | number | symbol = any,
>(
    properties?: DataBlockProperties,
): TurboYBlock<YType, KeyType, IdType>
Type Parameters
- YType extends YMap<any> | YArray<any> = YMap<any> | YArray<any>
- KeyType extends string | number | symbol = any
- IdType extends string | number | symbol = any
Parameters
- properties: DataBlockProperties = {}
Returns TurboYBlock<YType, KeyType, IdType>
Inherited from TurboDataBlock.constructor
- Defined in src/turboComponents/blocks/dataBlock/dataBlock.ts:37

Properties

id

id: IdType

data

data: YType

`Protected`isInitialized

isInitialized: boolean = false

`Protected` `Readonly`changeObservers

changeObservers: TurboWeakSet<BlockChangeObserver<any, any, KeyType>> = ...

`Readonly`onKeyChanged

onKeyChanged: Delegate<(key: KeyType, value: any) => void> = ...

Accessors

values

get values(): unknown[]
Returns unknown[]
Inherited from TurboDataBlock.values
- Defined in src/turboComponents/blocks/dataBlock/dataBlock.ts:84

enabledCallbacks

set enabledCallbacks(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides TurboDataBlock.enabledCallbacks
- Defined in src/turboComponents/blocks/yBlock/yBlock.ts:17

keys

get keys(): KeyType[]
Function
keys

Returns KeyType[]
Array of keys.

Description
Retrieves all keys within the given block(s).
Overrides TurboDataBlock.keys
- Defined in src/turboComponents/blocks/yBlock/yBlock.ts:77

size

get size(): number
Function
size

Returns number
The size.

Description
Returns the size of the specified block.
Overrides TurboDataBlock.size
- Defined in src/turboComponents/blocks/yBlock/yBlock.ts:92

Methods

toJSON

toJSON(): object
Returns object
Inherited from TurboDataBlock.toJSON
- Defined in src/turboComponents/blocks/dataBlock/dataBlock.ts:114

link

link(host: DataBlockHost<YType, KeyType, IdType>): void
Parameters
- host: DataBlockHost<YType, KeyType, IdType>
Returns void
Inherited from TurboDataBlock.link
- Defined in src/turboComponents/blocks/dataBlock/dataBlock.ts:130

unlink

unlink(): void
Returns void
Inherited from TurboDataBlock.unlink
- Defined in src/turboComponents/blocks/dataBlock/dataBlock.ts:134

makeSignal

makeSignal<Type = any>(key: KeyType): SignalBox<Type>
Type Parameters
- Type = any
Parameters
- key: KeyType
Returns SignalBox<Type>
Inherited from TurboDataBlock.makeSignal
- Defined in src/turboComponents/blocks/dataBlock/dataBlock.ts:144

getSignal

getSignal(key: KeyType): SignalBox<unknown>
Parameters
- key: KeyType
Returns SignalBox<unknown>
Inherited from TurboDataBlock.getSignal
- Defined in src/turboComponents/blocks/dataBlock/dataBlock.ts:152

makeAllSignals

makeAllSignals(): void
Returns void
Inherited from TurboDataBlock.makeAllSignals
- Defined in src/turboComponents/blocks/dataBlock/dataBlock.ts:156

generateObserver

generateObserver(
properties?: BlockChangeObserverProperties<any, any, KeyType>,
): BlockChangeObserver<any, any, KeyType>
Parameters
- properties: BlockChangeObserverProperties<any, any, KeyType> = {}
Returns BlockChangeObserver<any, any, KeyType>
Inherited from TurboDataBlock.generateObserver
- Defined in src/turboComponents/blocks/dataBlock/dataBlock.ts:166

`Protected`keyChanged

keyChanged(key: KeyType, value?: unknown, deleted?: boolean): void
Parameters
- key: KeyType
- value: unknown = ...
- deleted: boolean = false
Returns void
Inherited from TurboDataBlock.keyChanged
- Defined in src/turboComponents/blocks/dataBlock/dataBlock.ts:249

get

get(key: KeyType): unknown
Function
get
Parameters
- key: KeyType
  The key to retrieve.
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.
Overrides TurboDataBlock.get
- Defined in src/turboComponents/blocks/yBlock/yBlock.ts:35

set

set(key: KeyType, value: unknown): void
Function
set
Parameters
- key: KeyType
  The key to update.
- value: unknown
  The value to assign.
Returns void
Description
Sets the value for a given key in the specified block and triggers callbacks (if enabled).
Overrides TurboDataBlock.set
- Defined in src/turboComponents/blocks/yBlock/yBlock.ts:48

has

has(key: KeyType): boolean
Parameters
- key: KeyType
Returns boolean
Overrides TurboDataBlock.has
- Defined in src/turboComponents/blocks/yBlock/yBlock.ts:58

delete

delete(key: KeyType): void
Parameters
- key: KeyType
Returns void
Overrides TurboDataBlock.delete
- Defined in src/turboComponents/blocks/yBlock/yBlock.ts:65

initialize

initialize(): void
Function
initialize

Returns void
Description
Initializes the block at the given key, and triggers callbacks for all the keys in its data.
Overrides TurboDataBlock.initialize
- Defined in src/turboComponents/blocks/yBlock/yBlock.ts:108

clear

clear(clearData?: boolean): void
Function
clear
Parameters
- clearData: boolean = true
Returns void
Description
Clears the block data.
Overrides TurboDataBlock.clear
- Defined in src/turboComponents/blocks/yBlock/yBlock.ts:113

`Protected`observeChanges

observeChanges(event: YEvent, transaction: any): void
Parameters
- event: YEvent
- transaction: any
Returns void
- Defined in src/turboComponents/blocks/yBlock/yBlock.ts:124

Class TurboYBlock<YType, KeyType, IdType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TurboYBlock<YType, KeyType, IdType>

Properties

id

data

ProtectedisInitialized

Protected ReadonlychangeObservers

ReadonlyonKeyChanged

Accessors

values

Returns unknown[]

enabledCallbacks

Parameters

Returns void

keys

Returns KeyType[]

Description

size

Returns number

Description

Methods

toJSON

Returns object

link

Parameters

Returns void

unlink

Returns void

makeSignal

Type Parameters

Parameters

Returns SignalBox<Type>

getSignal

Parameters

Returns SignalBox<unknown>

makeAllSignals

Returns void

generateObserver

Parameters

Returns BlockChangeObserver<any, any, KeyType>

ProtectedkeyChanged

Parameters

Returns void

get

Parameters

Returns unknown

Description

set

Parameters

Returns void

Description

has

Parameters

Returns boolean

delete

Parameters

Returns void

initialize

Returns void

Description

clear

Parameters

Returns void

Description

ProtectedobserveChanges

Parameters

Returns void

Settings

On This Page

`Protected`isInitialized

`Protected` `Readonly`changeObservers

`Readonly`onKeyChanged

`Protected`keyChanged

`Protected`observeChanges