Class RealtimeAsset

Represents an asset in sharedb

Hierarchy

Events
- RealtimeAsset

Index

Constructors

Accessors

data id loaded uniqueId

Methods

load submitOp unload whenNothingPending

Constructors

constructor

new RealtimeAsset(
    uniqueId: number,
    realtime: Realtime,
    connection: RealtimeConnection,
): RealtimeAsset
Constructor
Parameters
- uniqueId: number
  The unique asset id
- realtime: Realtime
  The realtime API
- connection: RealtimeConnection
  The realtime connection
Returns RealtimeAsset
Overrides Events.constructor
- Defined in src/realtime/asset.ts:32

Accessors

data

get data(): any
The asset data

Returns any
- Defined in src/realtime/asset.ts:149

id

get id(): number
The asset id - used in combination with branch id

Returns number
- Defined in src/realtime/asset.ts:156

loaded

get loaded(): boolean
Whether the asset is loaded

Returns boolean
- Defined in src/realtime/asset.ts:142

uniqueId

get uniqueId(): number
The asset's unique id

Returns number
- Defined in src/realtime/asset.ts:163

Methods

load

load(): void
Loads asset from sharedb and subscribes to changes.

Returns void
- Defined in src/realtime/asset.ts:46

submitOp

submitOp(op: object, callback?: Function): void
Submits sharedb operation
Parameters
- op: object
  The operation
- Optionalcallback: Function
  The callback
Returns void
- Defined in src/realtime/asset.ts:81

unload

unload(): void
Unloads asset from sharedb and unsubscribes from changes.

Returns void
- Defined in src/realtime/asset.ts:61

whenNothingPending

whenNothingPending(callback: Function): void
Calls the callback when there are no changes pending to be sent to the server
Parameters
- callback: Function
  The callback
Returns void
- Defined in src/realtime/asset.ts:98