Interface CustomCommandOptions

interface CustomCommandOptions {
    dataKey?: string;
    delay?: boolean;
    id?: string | number;
    processValues?: boolean;
    shared?: boolean;
}

Properties

dataKey? delay? id? processValues? shared?

Properties

Optional dataKey

dataKey?: string

Object property that holds data, defaults to 'data'

Optional delay

delay?: boolean

Whenever the command should be delayed until the connection is established or not, defaults to true

Optional id

id?: string | number

Connection uuid, defaults to generate new uuid

Optional processValues

processValues?: boolean

Whenever the values should be processed and errors emited or not, defaults to true

Optional shared

shared?: boolean

Indicates whether this method should be shared. Only possible if it has an unsubCommand. When shared, the request is sent only once and the responses are shared with all methods using the same command and params. Defaults to true

Settings

Member Visibility

Theme

On This Page

dataKeydelayidprocessValuesshared