QUserType - Documentation

new QUserType(obj)

Source:

types.js, line 822

Parameters:

Name	Type	Description
`obj`	*

Extends

module:qtdatastream/types.QClass

Methods

(protected, static) createComplexUserType(name, value) → {QUserType}

Source:

types.js, line 835

Parameters:

Name	Type	Description
`name`	String
`value`	*

Returns:

a new class that extends QUserType

Type: QUserType

(protected, static) createUserType(name, value) → {QUserType}

Source:

types.js, line 891

Parameters:

Name	Type	Description
`name`	String
`value`	*

Returns:

a new class that extends QUserType

Type: QUserType

(static) get(name)

Source:

types.js, line 946

Get a previously registered usertype

Parameters:

Name	Type	Description
`name`	string

(static) read(buffer, name) → {*}

Source:

types.js, line 957

Parameters:

Name	Type	Description
`buffer`	Buffer
`name`	string	name with which the usertype has been registered

Returns:

Buffer coerced to whatever have been registered

Type: *

(static) register(name, value)

Source:

types.js, line 922

Example

const { QUserType } = require('qtdatastream').types;
QUserType.register('NWI', types.Types.INT);
QUserType.register('BufferInfo', [
  { type: types.Types.SHORT },
  { name: types.Types.BYTEARRAY },
  { ni1: 'NWI' },
  { ni2: 'NWI' }
]);

Parameters:

Name	Type	Description
`name`	string
`value`	*

(inner) toBuffer() → {Buffer}

Source:

types.js, line 987

Returns:

Type: Buffer