Class ProtobufSerializer

Hierarchy

DataSerializer
- ProtobufSerializer

Index

Constructors

Properties

deserializer eventEmitter knownTypes options root serializer wrapperMessage

Methods

clone deserialize findRootMetaInfo findTypeByName getMetadata getRootMetadata initialize registerType serialize unregisterType

Constructors

constructor

new ProtobufSerializer(): ProtobufSerializer

Returns ProtobufSerializer

Inherited from DataSerializer.constructor

Properties

`Protected` `Static` `Readonly`deserializer

deserializer: Deserializer

`Protected` `Static`eventEmitter

eventEmitter: EventEmitter

`Protected` `Static` `Readonly`knownTypes

knownTypes: Map<string, Serializable<any>>

`Protected` `Static`options

options: ProtobufSerializerConfig = ...

`Protected` `Static`root

root: Root

`Protected` `Static` `Readonly`serializer

serializer: Serializer

`Protected` `Static`wrapperMessage

wrapperMessage: Type

Methods

`Static`clone

clone<T, D = T>(object: T, dataType?: Constructor<D>): D
Clone a serializable object
Type Parameters
- T
- D = T
Parameters
- object: T
  Serializable object
- OptionaldataType: Constructor<D>
  Data type to clone to
Returns D
Cloned object
Inherited from DataSerializer.clone
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:80

`Static`deserialize

deserialize<T>(
    serializedData: any,
    dataType?: Constructor<T>,
    config?: DataSerializerConfig,
): T
Deserialize data
Type Parameters
- T
Parameters
- serializedData: any
  Data to deserialze
- OptionaldataType: Constructor<T>
  Optional data type to specify deserialization type
- Optionalconfig: DataSerializerConfig
  Data serializer configuration
Returns T
Overrides DataSerializer.deserialize
- Defined in src/ProtobufSerializer.ts:157

`Static`findRootMetaInfo

findRootMetaInfo(proto: any): ObjectMetadata
Find the root TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getRootMetadata
Inherited from DataSerializer.findRootMetaInfo
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:67

`Static`findTypeByName

findTypeByName(name: string): Serializable<any>
Parameters
- name: string
Returns Serializable<any>
Inherited from DataSerializer.findTypeByName
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:73

`Static`getMetadata

getMetadata(proto: any): ObjectMetadata
Get the TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getMetadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d
Inherited from DataSerializer.getMetadata
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:52

`Static`getRootMetadata

getRootMetadata(proto: any): ObjectMetadata
Get the root TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getRootMetadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d
Inherited from DataSerializer.getRootMetadata
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:60

`Static`initialize

initialize(directory?: string): Promise<void>
Initialize the protocol buffer serializer
Parameters
- Optionaldirectory: string
  Directory of generated protocol messages. Default will generate on the fly
Returns Promise<void>
Promise once initialized
- Defined in src/ProtobufSerializer.ts:39

`Static`registerType

registerType<T>(
type: Serializable<T>,
converters?: MappedTypeConverters<T>,
): void
Manually register a new type
Type Parameters
- T
Parameters
- type: Serializable<T>
  Type to register
- Optionalconverters: MappedTypeConverters<T>
  Optional converters
Returns void
Inherited from DataSerializer.registerType
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:44

`Static`serialize

serialize<T>(data: T, config?: DataSerializerConfig): Uint8Array
Serialize data
Type Parameters
- T
Parameters
- data: T
  Data to serialize
- Optionalconfig: DataSerializerConfig
  Data serializer configuration
Returns Uint8Array
Serialized buffer
Overrides DataSerializer.serialize
- Defined in src/ProtobufSerializer.ts:135

`Static`unregisterType

unregisterType(type: Serializable<any>): void
Unregister a type
Parameters
- type: Serializable<any>
  Type to unregister
Returns void
Inherited from DataSerializer.unregisterType
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:72

Class ProtobufSerializer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ProtobufSerializer

Properties

Protected Static Readonlydeserializer

Protected StaticeventEmitter

Protected Static ReadonlyknownTypes

Protected Staticoptions

Protected Staticroot

Protected Static Readonlyserializer

Protected StaticwrapperMessage

Methods

Staticclone

Type Parameters

Parameters

Returns D

Staticdeserialize

Type Parameters

Parameters

Returns T

StaticfindRootMetaInfo

Parameters

Returns ObjectMetadata

Deprecated

StaticfindTypeByName

Parameters

Returns Serializable<any>

StaticgetMetadata

Parameters

Returns ObjectMetadata

Deprecated

See

StaticgetRootMetadata

Parameters

Returns ObjectMetadata

Deprecated

See

Staticinitialize

Parameters

Returns Promise<void>

StaticregisterType

Type Parameters

Parameters

Returns void

Staticserialize

Type Parameters

Parameters

Returns Uint8Array

StaticunregisterType

Parameters

Returns void

Settings

On This Page

`Protected` `Static` `Readonly`deserializer

`Protected` `Static`eventEmitter

`Protected` `Static` `Readonly`knownTypes

`Protected` `Static`options

`Protected` `Static`root

`Protected` `Static` `Readonly`serializer

`Protected` `Static`wrapperMessage

`Static`clone

`Static`deserialize

`Static`findRootMetaInfo

`Static`findTypeByName

`Static`getMetadata

`Static`getRootMetadata

`Static`initialize

`Static`registerType

`Static`serialize

`Static`unregisterType