ISharedCell Interface

Shared cell interface

Signature

export interface ISharedCell<T = any> extends ISharedObject<ISharedCellEvents<T>>

Extends: ISharedObject<ISharedCellEvents

Type Parameters

Parameter	Default	Description
T	any

Methods

Method	Return Type	Description
delete()	void	Delete the value from the cell.
empty()	boolean	Checks whether cell is empty or not.
get()	Serializable<T> | undefined	Retrieves the cell value.
set(value)	void	Sets the cell value.

Method Details

delete

Delete the value from the cell.

Signature

delete(): void;

empty

Checks whether cell is empty or not.

Signature

empty(): boolean;

Returns

• true if the value of cell is undefined, false otherwise

Return type: boolean

get

Retrieves the cell value.

Signature

get(): Serializable<T> | undefined;

Returns

• the value of the cell

Return type: Serializable<T> | undefined

set

Sets the cell value.

Signature

set(value: Serializable<T>): void;

Parameters

Parameter	Type	Description
value	Serializable<T>	a JSON-able or SharedObject value to set the cell to