ISharedCell Interface

Packages > @fluidframework/cell > ISharedCell

Shared cell interface

Signature:

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

Extends: ISharedObject<ISharedCellEvents<T>>

Methods

List of methods of this class
Method Description
delete() Delete the value from the cell.
empty() Checks whether cell is empty or not.
get() Retrieves the cell value.
set(value) Sets the cell value.

Methods

delete

Delete the value from the cell.

Signature:

delete(): void;

Returns:

void

empty

Checks whether cell is empty or not.

Signature:

empty(): boolean;

Returns:

boolean

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

get

Retrieves the cell value.

Signature:

get(): T | undefined;

Returns:

T | undefined

  • the value of the cell

set

Sets the cell value.

Signature:

set(value: T): void;

Parameters

List of parameters
Parameter Type Description
value T a JSON-able or SharedObject value to set the cell to

Returns:

void