Options

The Options class represents the options for a node.

Constructors

new Options(options, actionsThis)

new Options(options, actionsThis): Options

Constructs a new Options object.

Parameters

• options: Options | OptionsProps= {}

The options for the node.

• actionsThis: any= null

The context for the actions.

Returns

Options

Source

ecmascript/src/options.ts:129

Properties

actions

actions: Object

Index signature

[key: string]: Function

Type declaration

addSymbol

addSymbol: Function

getSymbol

getSymbol: Function

Source

ecmascript/src/options.ts:78

---

batchActionPayloadSizes

batchActionPayloadSizes: Object

Source

ecmascript/src/options.ts:83

---

compressStringsAsInts

compressStringsAsInts: boolean

Source

ecmascript/src/options.ts:84

---

defaultSymbols

defaultSymbols: string[]

Source

ecmascript/src/options.ts:85

---

enableQuerying

enableQuerying: boolean

Source

ecmascript/src/options.ts:87

---

enableRollback

enableRollback: boolean

Source

ecmascript/src/options.ts:86

---

enumDefaultSymbols

enumDefaultSymbols: Object

Source

ecmascript/src/options.ts:88

---

getActorId

getActorId: Function

Source

ecmascript/src/options.ts:89

---

getGroupedValue

getGroupedValue: Function

Source

ecmascript/src/options.ts:90

---

indexes

indexes: Object

Source

ecmascript/src/options.ts:91

---

isAsyncStorage

isAsyncStorage: boolean

Source

ecmascript/src/options.ts:93

---

isAuthority

isAuthority: boolean

Source

ecmascript/src/options.ts:92

---

isComponentRelay

isComponentRelay: boolean

Source

ecmascript/src/options.ts:94

---

isDiffed

isDiffed: boolean

Source

ecmascript/src/options.ts:95

---

isGroupedComponents

isGroupedComponents: boolean

Source

ecmascript/src/options.ts:96

---

isOrdered

isOrdered: boolean

Source

ecmascript/src/options.ts:97

---

isReadOnly

isReadOnly: boolean

Source

ecmascript/src/options.ts:98

---

isSymbolLeader

isSymbolLeader: boolean

Source

ecmascript/src/options.ts:99

---

isSymbolRelay

isSymbolRelay: boolean

Source

ecmascript/src/options.ts:100

---

onUpdate

onUpdate: null | Function

Source

ecmascript/src/options.ts:101

---

pageSize

pageSize: number

Source

ecmascript/src/options.ts:102

---

responder

responder: Function

Source

ecmascript/src/options.ts:103

---

setGroupedValue

setGroupedValue: Function

Source

ecmascript/src/options.ts:106

---

skipPending

skipPending: boolean

Source

ecmascript/src/options.ts:104

---

storeOptions

storeOptions: Object

Source

ecmascript/src/options.ts:107

---

types

types: Object

Source

ecmascript/src/options.ts:105

---

updateOptions

updateOptions: UpdateOptions

Source

ecmascript/src/options.ts:108

Methods

clone()

clone(): Options

Creates a new Options object from the current one.

Returns

Options

Source

ecmascript/src/options.ts:212

---

extend()

extend(options, actionThis): Options

Extends the current Options object.

Parameters

• options: Object | Options | OptionsProps

The options for the node.

• actionThis: any= undefined

The context for the actions.

Returns

Options

Source

ecmascript/src/options.ts:222

---

ensure()

static ensure(options, actionsThis): Options

Ensures that the provided options are an instance of Options.

Parameters

• options: Options | OptionsProps= {}

The options for the node.

• actionsThis: any

The context for the actions.

Returns

Options

• An instance of Options.

Source

ecmascript/src/options.ts:119

---

Generated using typedoc-plugin-markdown and TypeDoc