Class SArray<ValueT>

constructor

• new SArray<ValueT extends Serializable>(): SArray<ValueT>

  Type Parameters

  • ValueT extends Serializable

  Returns SArray<ValueT>

Optional ReadonlyelementType

Optional Readonlylength

value

assignJSON

• assignJSON(jsonValues: unknown[]): void

  Assigns elements from a JSON array.

  Conceptually equivalent to assigning to this.values directly, but recursively hydrates SObjects / SArrays / SerializableWrappers etc and invokes their assignJSON() to process JSON values.

  Parameters

  • jsonValues: unknown[]

  Returns void

deserialize

• deserialize(buffer: Buffer, opts?: DeserializeOptions): number

  Deserializes a buffer into this value.

  Parameters

  • buffer: Buffer
  • Optionalopts: DeserializeOptions

  Returns number

  Number of bytes read.

getSerializedLength

• getSerializedLength(opts?: SerializeOptions): number

  Computes the serialized length of this value.

  Parameters

  • Optionalopts: SerializeOptions

  Returns number

serialize

• serialize(opts?: SerializeOptions): Buffer

  Serializes this value into a buffer.

  Parameters

  • Optionalopts: SerializeOptions

  Returns Buffer

toJSON

• toJSON(): any

  Returns any

Staticof

• of<ValueT extends Serializable, SArrayT extends SArray<ValueT>>(
      this: new () => SArrayT,
      value: ValueT[],
  ): SArrayT

  Create a new instance of this wrapper class from a raw value.

  Type Parameters

  • ValueT extends Serializable
  • SArrayT extends SArray<ValueT>

  Parameters

  • this: new () => SArrayT
  • value: ValueT[]

  Returns SArrayT
• of<ValueT>(wrapperType: new () => SerializableWrapper<ValueT>): typeof __class

  Returns an SArrayWithWrapper class that wraps elements with the provided SerializableWrapper.

  Type Parameters

  • ValueT

  Parameters

  • wrapperType: new () => SerializableWrapper<ValueT>

  Returns typeof __class

StaticofLength

• ofLength<ValueT extends Serializable>(
      length: number,
      elementType: new () => ValueT,
  ): typeof __class

  Returns an SArray class that pads / truncates to the provided length.

  Type Parameters

  • ValueT extends Serializable

  Parameters

  • length: number
  • elementType: new () => ValueT

  Returns typeof __class