Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Serializer

Provides methods for serializing/deserializing .NET value types to/from JSON as well as facilities for converting objects and arrays if appropriate callbacks are supplied to assist with the conversion.

Hierarchy

  • JsonSerializer
    • Serializer

Index

Constructors

constructor

Methods

getTypeString

  • getTypeString(): string

Static deserializeBoolean

  • deserializeBoolean(valueJson: string): boolean
  • Deserializes a boolean value.

    Parameters

    • valueJson: string

      The boolean JSON to deserialize.

    Returns boolean

    The deserialized boolean value.

Static deserializeBooleanArray

  • deserializeBooleanArray(arrayJson: string): boolean[]
  • Deserializes a boolean array from JSON.

    Parameters

    • arrayJson: string

      A JSON-serialized boolean array.

    Returns boolean[]

    An array of boolean values.

Static deserializeDecimal

  • deserializeDecimal(valueJson: string): number
  • Deserializes a decimal value.

    Parameters

    • valueJson: string

      The decimal JSON to deserialize.

    Returns number

    The deserialized decimal value.

Static deserializeDecimalArray

  • deserializeDecimalArray(arrayJson: string): number[]
  • Deserializes a decimal array from JSON.

    Parameters

    • arrayJson: string

      A JSON-serialized decimal array.

    Returns number[]

    An array of decimal values.

Static deserializeDictionary

  • deserializeDictionary<T>(dictionaryJson: string, createDictionaryCallback: IFunction0<Hash<string, T>>, deserializeValueCallback: IFunction1<string, T>): Hash<string, T>
  • Deserializes a JSON string into a dictionary.
    The type of value stored in the dictionary.

    Type parameters

    • T

    Parameters

    • dictionaryJson: string

      The JSON-encoded dictionary.

    • createDictionaryCallback: IFunction0<Hash<string, T>>

      The callback that creates a blank dictionary.

    • deserializeValueCallback: IFunction1<string, T>

      The callback that deserializes a value.

    Returns Hash<string, T>

    The deserialized dictionary.

Static deserializeDouble

  • deserializeDouble(valueJson: string): number
  • Deserializes a double value.

    Parameters

    • valueJson: string

      The double JSON to deserialize.

    Returns number

    The deserialized double value.

Static deserializeDoubleArray

  • deserializeDoubleArray(arrayJson: string): number[]
  • Deserializes a double array from JSON.

    Parameters

    • arrayJson: string

      A JSON-serialized double array.

    Returns number[]

    An array of double values.

Static deserializeFloat

  • deserializeFloat(valueJson: string): number
  • Deserializes a float value.

    Parameters

    • valueJson: string

      The float JSON to deserialize.

    Returns number

    The deserialized float value.

Static deserializeFloatArray

  • deserializeFloatArray(arrayJson: string): number[]
  • Deserializes a float array from JSON.

    Parameters

    • arrayJson: string

      A JSON-serialized float array.

    Returns number[]

    An array of float values.

Static deserializeGuid

  • deserializeGuid(valueJson: string): Guid
  • Deserializes a globally unique identifier.

    Parameters

    • valueJson: string

      The GUID JSON to deserialize.

    Returns Guid

    The deserialized GUID.

Static deserializeGuidArray

  • deserializeGuidArray(arrayJson: string): Guid[]
  • Deserializes a GUID array from JSON.

    Parameters

    • arrayJson: string

      A JSON-serialized GUID array.

    Returns Guid[]

    An array of GUID values.

Static deserializeInteger

  • deserializeInteger(valueJson: string): number
  • Deserializes an integer value.

    Parameters

    • valueJson: string

      The integer JSON to deserialize.

    Returns number

    The deserialized integer value.

Static deserializeIntegerArray

  • deserializeIntegerArray(arrayJson: string): number[]
  • Deserializes a integer array from JSON.

    Parameters

    • arrayJson: string

      A JSON-serialized integer array.

    Returns number[]

    An array of integer values.

Static deserializeLong

  • deserializeLong(valueJson: string): number
  • Deserializes a long value.

    Parameters

    • valueJson: string

      The long JSON to deserialize.

    Returns number

    The deserialized long value.

Static deserializeLongArray

  • deserializeLongArray(arrayJson: string): number[]
  • Deserializes a long array from JSON.

    Parameters

    • arrayJson: string

      A JSON-serialized long array.

    Returns number[]

    An array of long values.

Static deserializeObject

  • deserializeObject<T>(json: string, creator: IFunction0<T>, callback: IAction3<T, string, string>): T
  • Deserializes a JSON string into a target object type.
    The type of the object to deserialize.

    Type parameters

    • T

    Parameters

    • json: string

      The JSON-encoded string.

    • creator: IFunction0<T>

      The method used for creating a new object.

    • callback: IAction3<T, string, string>

      The method used for deserializing a property.

    Returns T

    The deserialized object.

Static deserializeObjectArray

  • deserializeObjectArray<T>(json: string, deserializer: IFunction1<string, T>): Array<T>
  • Deserializes a JSON string into an array of target object types.
    The type of the object to deserialize.

    Type parameters

    • T

    Parameters

    • json: string

      The JSON-encoded string.

    • deserializer: IFunction1<string, T>

      The callback used to deserialize each item in the array.

    Returns Array<T>

    An array of deserialized objects.

Static deserializeObjectFast

  • deserializeObjectFast<T>(json: string, creator: IFunction0<T>, callback: IAction3<T, string, string>): T
  • Deserializes a JSON string into a fm.icelink.serializable target object type.
    The type of the object to deserialize.

    Type parameters

    • T: Serializable

    Parameters

    • json: string

      The JSON-encoded string.

    • creator: IFunction0<T>

      The method used for creating a new object.

    • callback: IAction3<T, string, string>

      The method used for deserializing a property.

    Returns T

    The deserialized object.

Static deserializeRaw

  • deserializeRaw(dataJson: string): string
  • Deserializes a piece of raw JSON.

    Parameters

    • dataJson: string

      The raw data.

    Returns string

    The deserialized data.

Static deserializeRawArray

  • deserializeRawArray(json: string): Array<string>
  • Deserializes a raw array from JSON.

    Parameters

    • json: string

      A JSON-serialized raw array.

    Returns Array<string>

    An array of raw values.

Static deserializeString

  • deserializeString(valueJson: string): string
  • Deserializes a string.

    Parameters

    • valueJson: string

      The string to deserialize.

    Returns string

    The deserialized string value.

Static deserializeStringArray

  • deserializeStringArray(arrayJson: string): string[]
  • Deserializes a simple string array from JSON.

    Parameters

    • arrayJson: string

      A JSON-serialized string array.

    Returns string[]

    An array of string values.

Static escapeString

  • escapeString(text: string): string
  • Escapes any special characters in a string.

    Parameters

    • text: string

      The string without escaped characters.

    Returns string

    The escaped string.

Static isValidJson

  • isValidJson(json: string): boolean
  • Determines whether the specified JSON string is valid.

    Parameters

    • json: string

      The JSON string to validate.

    Returns boolean

    True if the JSON string is valid; false otherwise.

Static serializeBoolean

  • serializeBoolean(value: boolean): string
  • Serializes a boolean value.

    Parameters

    • value: boolean

      The boolean to serialize.

    Returns string

    The serialized boolean value.

Static serializeBooleanArray

  • serializeBooleanArray(array: boolean[]): string
  • Serializes a boolean array to JSON.

    Parameters

    • array: boolean[]

      An array of boolean values.

    Returns string

    A JSON-serialized boolean array.

Static serializeDecimal

  • serializeDecimal(value: number): string
  • Serializes a decimal value.

    Parameters

    • value: number

      The decimal to serialize.

    Returns string

    The serialized decimal value.

Static serializeDecimalArray

  • serializeDecimalArray(array: number[]): string
  • Serializes a decimal array to JSON.

    Parameters

    • array: number[]

      An array of decimal values.

    Returns string

    A JSON-serialized decimal array.

Static serializeDictionary

  • serializeDictionary<T>(dictionary: Hash<string, T>, serializeValueCallback: IFunction1<T, string>): string
  • Serializes a dictionary into a JSON string.
    The type of value stored in the dictionary.

    Type parameters

    • T

    Parameters

    • dictionary: Hash<string, T>

      The dictionary being serialized.

    • serializeValueCallback: IFunction1<T, string>

      The callback that serializes a value.

    Returns string

    The dictionary as a JSON string.

Static serializeDouble

  • serializeDouble(value: number): string
  • Serializes a double value.

    Parameters

    • value: number

      The double to serialize.

    Returns string

    The serialized double value.

Static serializeDoubleArray

  • serializeDoubleArray(array: number[]): string
  • Serializes a double array to JSON.

    Parameters

    • array: number[]

      An array of double values.

    Returns string

    A JSON-serialized double array.

Static serializeFloat

  • serializeFloat(value: number): string
  • Serializes a float value.

    Parameters

    • value: number

      The float to serialize.

    Returns string

    The serialized float value.

Static serializeFloatArray

  • serializeFloatArray(array: number[]): string
  • Serializes a float array to JSON.

    Parameters

    • array: number[]

      An array of float values.

    Returns string

    A JSON-serialized float array.

Static serializeGuid

  • serializeGuid(value: Guid): string
  • Serializes a globally unique identifier.

    Parameters

    • value: Guid

      The GUID to serialize.

    Returns string

    The serialized GUID.

Static serializeGuidArray

  • serializeGuidArray(array: Guid[]): string
  • Serializes a GUID array to JSON.

    Parameters

    • array: Guid[]

      An array of GUID values.

    Returns string

    A JSON-serialized GUID array.

Static serializeInteger

  • serializeInteger(value: number): string
  • Serializes an integer value.

    Parameters

    • value: number

      The integer to serialize.

    Returns string

    The serialized integer value.

Static serializeIntegerArray

  • serializeIntegerArray(array: number[]): string
  • Serializes a integer array to JSON.

    Parameters

    • array: number[]

      An array of integer values.

    Returns string

    A JSON-serialized integer array.

Static serializeLong

  • serializeLong(value: number): string
  • Serializes a long value.

    Parameters

    • value: number

      The long to serialize.

    Returns string

    The serialized long value.

Static serializeLongArray

  • serializeLongArray(array: number[]): string
  • Serializes a long array to JSON.

    Parameters

    • array: number[]

      An array of long values.

    Returns string

    A JSON-serialized long array.

Static serializeObject

  • serializeObject<T>(source: T, callback: IAction2<T, Hash<string, string>>): string
  • Serializes an object into a JSON string.
    The type of the object to serialize.

    Type parameters

    • T

    Parameters

    • source: T

      The object being serialized.

    • callback: IAction2<T, Hash<string, string>>

      The method used for serializing properties.

    Returns string

    The object as a JSON string.

Static serializeObjectArray

  • serializeObjectArray<T>(objects: T[], serializer: IFunction1<T, string>): string
  • Serializes an object array into a JSON string.
    The type of the object to serialize.

    Type parameters

    • T

    Parameters

    • objects: T[]

      The object array being serialized.

    • serializer: IFunction1<T, string>

      The callback used to serialize each item in the array.

    Returns string

    The object array as a JSON string.

Static serializeObjectFast

  • serializeObjectFast<T>(source: T, callback: IAction2<T, Hash<string, string>>): string
  • Serializes a fm.icelink.serializable object into a JSON string.
    The type of the object to serialize.

    Type parameters

    • T: Serializable

    Parameters

    • source: T

      The object being serialized.

    • callback: IAction2<T, Hash<string, string>>

      The method used for serializing properties.

    Returns string

    The object as a JSON string.

Static serializeRaw

  • serializeRaw(dataJson: string): string
  • Serializes a piece of raw JSON.

    Parameters

    • dataJson: string

      The raw data.

    Returns string

    The serialized data.

Static serializeRawArray

  • serializeRawArray(jsons: string[]): string
  • Serializes a raw array to JSON.

    Parameters

    • jsons: string[]

      An array of raw values.

    Returns string

    A JSON-serialized raw array.

Static serializeString

  • serializeString(value: string): string
  • Serializes a string.

    Parameters

    • value: string

      The string to serialize.

    Returns string

    The serialized string value.

Static serializeStringArray

  • serializeStringArray(array: string[]): string
  • Serializes a string array to JSON.

    Parameters

    • array: string[]

      An array of string values.

    Returns string

    A JSON-serialized string array.

Static trimQuotes

  • trimQuotes(value: string): string
  • Trims the quotes from a JavaScript string value.

    Parameters

    • value: string

      The JavaScript string value.

    Returns string

    The string without quotes.

Static unescapeString

  • unescapeString(text: string): string
  • Unescapes any special characters from a string.

    Parameters

    • text: string

      The string with escaped characters.

    Returns string

    The unescaped string.