Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StringDataType

String data type.

Accessed via: diffusion.datatypes.string();

Provides a data type implementation which supports string values. The string value is serialized in CBOR-format binary.

This data type supports null string instances.

since

6.0

Hierarchy

Index

Methods

canReadAs

  • canReadAs(valueType: object): boolean
  • Test whether this data type is compatible with valueType. Compatibility with a valueType means than any valid binary representation of a value can be read as an instance of valueType.

    Every data type should be compatible with the following:

    • Value Type – the class corresponding to the data type's value type.

    For a data type with a value type of X, readAs(X, buffer) is equivalent to readValue(buffer).

    since

    6.0

    Parameters

    • valueType: object

      the type to check

    Returns boolean

    true if a binary representation created by this data type can read as an instance * of valueType

deltaType

  • Obtain a DeltaType by name or delta type.

    Example:

    // Get by name
    var deltas = datatype.deltaType("binary");

    Example:

    // Get by type
    var deltas = datatype.deltaType(delta);

    Parameters

    • Optional name: undefined | string

      the name, as returned by DeltaType.name

    Returns DeltaType<String, StringSourceType, Bytes>

    the delta type

name

  • name(): string
  • The external type identifier.

    Returns string

    the name of this datatype

readAs

  • readAs(valueType: object, buffer: Buffer, offset?: undefined | number, length?: undefined | number): any | null
  • readAs(valueType: object, buffer: Bytes): any | null
  • Create a value of a compatible class from binary.

    throws

    an error if valueType is incompatible with this data type, or buffer does not * represent a valid value.

    since

    6.0

    Parameters

    • valueType: object

      the type of the result

    • buffer: Buffer

      the binary data

    • Optional offset: undefined | number

      the offset to start reading from the provided buffer (default = 0)

    • Optional length: undefined | number

      the length of the data to read (default = input.length)

    Returns any | null

    the value in the form of the specified type

  • Parameters

    • valueType: object
    • buffer: Bytes

    Returns any | null

readValue

  • readValue(input: Buffer, offset?: undefined | number, length?: undefined | number): String | null
  • readValue(input: Bytes): String | null
  • Parse a value from binary.

    throws

    an error if the data is invalid for this type

    Parameters

    • input: Buffer

      the binary data

    • Optional offset: undefined | number

      the offset to start reading from the provided buffer (default = 0)

    • Optional length: undefined | number

      the length of the data to read (default = input.length)

    Returns String | null

    an instance of this data type value

  • Parameters

    Returns String | null

writeValue

  • Serialise a value to binary

    throws

    an error if the value can not be serialised

    Parameters

    Returns Buffer

    the serialised value as a buffer