palm-sync
    Preparing search index...

    Class CmpDatagram

    CMP datagram.

    Hierarchy

    • SObject
      • CmpDatagram
    Index

    Constructors

    Properties

    Flags.

    Will be set to correct type based on datagram type during deserialiation. Will be type checked during serialization.

    baudRate: number = 0

    Baud rate to use.

    type: CmpDatagramType = CmpDatagramType.INIT

    CMP datagram type.

    Methods

    • Assign properties to this object from a JSON object.

      Conceptually equivalent to Object.assign(), but recursively hydrates SObjects / SArrays / SerializableWrappers etc and invokes their assignJSON() to process JSON values. For example:

      class A extends SObject {
      @field(SUInt8) prop1: number;
      }
      class B extends SObject {
      @field() a = new A();
      }
      const b1 = new B();
      b1.assignJSON({a: {prop1: 300}});

      Parameters

      • jsonObject: { [key: string | symbol]: unknown }

      Returns void

    • Assign properties to this object from a map of Serializables.

      Conceptually equivalent to Object.assign(), but automatically unwraps wrapped properties. Fields defined with @field() are directly assigned, and fields defined with @field(wrapper) are assigned by unwrapping the corresponding SerializableWrapper. Unknown fields are considered an error.

      Parameters

      • serializableMap: { [propertyKey: string | symbol]: Serializable }

      Returns void

    • Parameters

      • buffer: Buffer
      • Optionalopts: DeserializeOptions

      Returns number

    • Computes the serialized length of this value.

      Parameters

      • Optionalopts: SerializeOptions

      Returns number

    • Parameters

      • Optionalopts: SerializeOptions

      Returns Buffer

    • Returns any

    • Map values of this object to Serializable.

      Fields defined with @field() are preserved as-is, and field defined with @field(wrapper) are wrapped in their respective wrapper types.

      Returns { [propertyKey: string]: Serializable }

    • Creates a new instance of this value by deserializing from a buffer.

      Type Parameters

      • T extends Serializable

      Parameters

      • this: new () => T
      • buffer: Buffer
      • Optionalopts: DeserializeOptions

      Returns T

    • Create a new instance with the provided initial properties.

      Type Parameters

      • T extends SObject

      Parameters

      • this: new () => T
      • Optionalprops: Partial<T>

      Returns T

    • Similar to with(), but uses assignJSON() instead of Object.assign().

      Type Parameters

      • T extends SObject

      Parameters

      • this: new () => T
      • json: { [key: string | symbol]: unknown }

      Returns T