Class WSCommandStorage

Hierarchy

WSCommandAbstract
- WSCommandStorage

Index

Constructors

Properties

COMMAND_FUNC_ID_ERROR _CommandRead _CommandSave _hw ioNotUsed module parsed?

Accessors

WSCommandNotFoundError

Methods

_filterSchema envelopError envelopWarning fastValidate filter getSchema isValidIO notifyFromBinary onlyTypeErrorMessage parseFromJson read save sendCommand setHw validate validateCommandSchema

Constructors

constructor

new WSCommandStorage(): WSCommandStorage
Returns WSCommandStorage
Inherited from WSCommandAbstract.constructor
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:45

Properties

COMMAND_FUNC_ID_ERROR

COMMAND_FUNC_ID_ERROR: number

_CommandRead

_CommandRead: number = 1

_CommandSave

_CommandSave: number = 0

_hw

_hw: HW

ioNotUsed

ioNotUsed: number

module

module: number = 17

`Optional` parsed

parsed?: ((module, func, payload) => void)

Type declaration

- (module, func, payload): void
- Parameters
  - module: number
  - func: number
  - payload: null | Uint8Array
  Returns void

Accessors

WSCommandNotFoundError

get WSCommandNotFoundError(): any
Returns any
Inherited from WSCommandAbstract.WSCommandNotFoundError
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:30

Methods

_filterSchema

_filterSchema(schema, json): any
Parameters
- schema: any
- json: any
Returns any
Inherited from WSCommandAbstract._filterSchema
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:217

envelopError

envelopError(objToSend, module_key, obj): void
Parameters
- objToSend: {
  [key: string]: any;
  }
  - [key: string]: any
- module_key: any
- obj: any
Returns void
Inherited from WSCommandAbstract.envelopError
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:113

envelopWarning

envelopWarning(objToSend, module_key, obj): void
Parameters
- objToSend: {
  [key: string]: any;
  }
  - [key: string]: any
- module_key: any
- obj: any
Returns void
Inherited from WSCommandAbstract.envelopWarning
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:102

fastValidate

fastValidate(commandUri, json): boolean
Parameters
- commandUri: any
- json: any
Returns boolean
Inherited from WSCommandAbstract.fastValidate
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:167

filter

filter(commandUri, json): any
Parameters
- commandUri: any
- json: any
Returns any
Inherited from WSCommandAbstract.filter
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:212

getSchema

getSchema(uri): any
Parameters
- uri: any
Returns any
Inherited from WSCommandAbstract.getSchema
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:128

isValidIO

isValidIO(io): boolean
Parameters
- io: number
Returns boolean
Inherited from WSCommandAbstract.isValidIO
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:124

notifyFromBinary

notifyFromBinary(objToSend, func, payload): void
Parameters
- objToSend: {
  [key: string]: any;
  }
  - [key: string]: any
- func: number
- payload: Uint8Array
Returns void
Overrides WSCommandAbstract.notifyFromBinary
- Defined in src/obniz/libs/wscommand/WSCommandStorage.ts:67

onlyTypeErrorMessage

onlyTypeErrorMessage(validateError, rootPath): string | boolean
Parameters
- validateError: any
- rootPath: any
Returns string | boolean
Inherited from WSCommandAbstract.onlyTypeErrorMessage
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:173

parseFromJson

parseFromJson(json): void
Parameters
- json: {
  [k: string]: unknown;
  }
  - [k: string]: unknown
Returns void
Overrides WSCommandAbstract.parseFromJson
- Defined in src/obniz/libs/wscommand/WSCommandStorage.ts:48

read

read(json): void
Parameters
- json: {
      read: {
          fileName: string;
      };
  }
  - read: {
    fileName: string;
    }
    - fileName: string
Returns void
- Defined in src/obniz/libs/wscommand/WSCommandStorage.ts:31

save

save(json): void
Parameters
- json: {
      save: {
          data: Uint8Array;
          fileName: string;
      };
  }
  - save: {
    data: Uint8Array;
    fileName: string;
    }
    - data: Uint8Array
    - fileName: string
Returns void
- Defined in src/obniz/libs/wscommand/WSCommandStorage.ts:10

sendCommand

sendCommand(func, payload): void
Parameters
- func: number
- payload: null | Uint8Array
Returns void
Inherited from WSCommandAbstract.sendCommand
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:61

setHw

setHw(obj): void
Parameters
- obj: HW
Returns void
Inherited from WSCommandAbstract.setHw
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:56

validate

validate(commandUri, json): MultiResult
Parameters
- commandUri: any
- json: any
Returns MultiResult
Inherited from WSCommandAbstract.validate
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:161

validateCommandSchema

validateCommandSchema(uriList, json, rootPath, customArg?): any
Parameters
- uriList: any
- json: any
- rootPath: any
- Optional customArg: any
Returns any
Inherited from WSCommandAbstract.validateCommandSchema
- Defined in src/obniz/libs/wscommand/WSCommandAbstract.ts:134

Generated using TypeDoc