OptionsProps
The OptionsProps interface represents the properties for the Options class.
Properties
actions?
actions?:
Object
An object containing the addSymbol and getSymbol functions.
Index signature
[key: string]: Function | undefined
Type declaration
addSymbol?
addSymbol?:
Function
getSymbol?
getSymbol?:
Function
Source
batchActionPayloadSizes?
batchActionPayloadSizes?:
Object
An object to specify the payload sizes for batch actions.
Source
compressStringsAsInts?
compressStringsAsInts?:
boolean
A flag to compress strings as integers.
Source
defaultSymbols?
defaultSymbols?:
string[]
An array of default symbols.
Source
enableQuerying?
enableQuerying?:
boolean
A flag to indicate if querying is enabled.
Source
enableRollback?
enableRollback?:
boolean
A flag to indicate if time rollback is enabled on inputs.
Source
enumDefaultSymbols?
enumDefaultSymbols?:
Object
An object containing the default symbols.
Source
getActorId?
getActorId?:
Function
A function to get the actor ID.
Source
getGroupedValue?
getGroupedValue?:
Function
A function to get the value from a group.
Source
indexes?
indexes?:
Object
An object containing the indexes.
Source
isAsyncStorage?
isAsyncStorage?:
boolean
A flag to indicate if the node uses async storage.
Source
isAuthority?
isAuthority?:
boolean
A flag to indicate if the node is an authority.
Source
isComponentRelay?
isComponentRelay?:
boolean
A flag to indicate if the node is a component relay.
Source
isDiffed?
isDiffed?:
boolean
A flag to indicate if the node is diffed.
Source
isGroupedComponents?
isGroupedComponents?:
boolean
A flag to indicate if the node uses grouped components.
Source
isOrdered?
isOrdered?:
boolean
A flag to indicate if the node is ticked.
Source
isReadOnly?
isReadOnly?:
boolean
A flag to indicate if the node is read only.
Source
isSymbolLeader?
isSymbolLeader?:
boolean
A flag to indicate if the node is a symbol leader.
Source
isSymbolRelay?
isSymbolRelay?:
boolean
A flag to indicate if the node is a symbol relay.
Source
onUpdate?
onUpdate?:
Function
A function to call when the node is updated.
Source
pageSize?
pageSize?:
number
The page size.
Source
responder?
responder?:
Function
A function to respond to actions.
Source
setGroupedValue?
setGroupedValue?:
Function
A function to set the value in a group.
Source
skipPending?
skipPending?:
boolean
A flag to skip pending actions.
Source
storeOptions?
storeOptions?:
Object
An object containing the store options.
Source
types?
types?:
Object
An object containing the types.
Source
updateOptions?
updateOptions?:
UpdateOptions
An object containing the valid keys for updates and any other options.
Source
Generated using typedoc-plugin-markdown and TypeDoc