Global

Type Definitions

cbType()

Source:

ctxType

Source:
Type:
  • Object.<string, Object>

jsonType

Source:
Type:
  • Object | Array | string | number | null | boolean

mapOptionsType

Source:
Properties:
Name Type Attributes Description
initialValue Object.<string, jsonType> <optional>

An optional initial value for a writable map.
bestEffort boolean <optional>

Ignore errors when we cannot create a replica. On failure the map is set to null and the client should retry adding it again.
noExec boolean <optional>

When true it always throws when calling applyMethod().
Type:
  • Object

mapUpdateType

Source:
Properties:
Name Type Description
version number

An initial version number for the map.
remove Array.<string>

Map keys to delete.
add Array.<(string|Object)>

Key/value pairs to add to the map. They are laid out in the array as [key1, val1, key2, val2, ... *
Type:
  • Object

messagesType

Source:
Properties:
Name Type Description
index number

The first message in messages or UNKNOWN_ACK_INDEX, i.e., -1, if no messages.
messages Array.<jsonType>

Messages received in the channel that have not been acknowledged previously.
Type:
  • Object

refMapType

Source:
Type:
  • Object

specDeltaType

Source:
Properties:
Name Type Attributes Description
name string <optional>
module string | null <optional>
description string <optional>
env Object <optional>
components Array.<specType> <optional>
Type:
  • Object

specType

Source:
Properties:
Name Type Attributes Description
name string
module string | null
description string <optional>
env Object
components Array.<specType> <optional>
Type:
  • Object