Class ConversionRegister

constructor

• new ConversionRegister(entries): ConversionRegister

• Constructor for ConversionRegister

  Parameters

  • entries: ConversionRegisterEntry<AllowAnyTypeInformation>[]

    Entries for the conversion register

  Returns ConversionRegister

Readonly entries

Static Readonly instance

deepExportArrayToString

• deepExportArrayToString(value, supportsValue?): unknown[]

• Deep-Export an array of values to an array of strings

  Parameters

  • value: unknown[]

    the array of values to export

  • supportsValue: ((it) => boolean) = ...

    Function to check if a value is supported and therefore should not be converted to a string

    • • (it): boolean

      • Parameters

        • it: unknown

        Returns boolean

  Returns unknown[]

  Array of strings

  Throws

  • Unsupported type

deepExportObjectToString

• deepExportObjectToString(value, supportsValue?): Record<string, unknown>

• Deep-Export an object of values to an object of strings

  Parameters

  • value: Record<string, unknown>

    Object of values to export

  • supportsValue: ((it) => boolean) = ...

    Function to check if a value is supported and therefore should not be converted to a string

    • • (it): boolean

      • Parameters

        • it: unknown

        Returns boolean

  Returns Record<string, unknown>

  Object of strings

  Throws

  • Unsupported type

deepExportToString

• deepExportToString(value, supportsValue?): unknown[]

• Deep-Export a value to a string

  Parameters

  • value: unknown[]

    Value to export

  • Optional supportsValue: ((it) => boolean)

    Function to check if a value is supported and therefore should not be converted to a string

    • • (it): boolean

      • Parameters

        • it: unknown

        Returns boolean

  Returns unknown[]

  String

  Throws

  • Unsupported type
• deepExportToString(value, supportsValue?): Record<string, unknown>

• Parameters

  • value: Record<string, unknown>

  • Optional supportsValue: ((it) => boolean)

    • • (it): boolean

      • Parameters

        • it: unknown

        Returns boolean

  Returns Record<string, unknown>

deepImportArrayFromString

• deepImportArrayFromString(value): unknown[]

• Deep-Import an array of values from an array of strings

  Parameters

  • value: unknown[]

    Array of strings to import

  Returns unknown[]

  Array of values

  Throws

  • Unsupported type

deepImportObjectFromString

• deepImportObjectFromString(value): Record<string, unknown>

• Deep-Import an object of values from an object of strings

  Parameters

  • value: Record<string, unknown>

    Object of strings

  Returns Record<string, unknown>

  Object of values

  Throws

  • Unsupported type

exportArrayToString

• exportArrayToString(value, supportsValue?): unknown[]

• Export an array of values to an array of strings

  Parameters

  • value: unknown[]

    the array of values to export

  • supportsValue: ((it) => boolean) = ...

    Function to check if a value is supported and therefore should not be converted to a string

    • • (it): boolean

      • Parameters

        • it: unknown

        Returns boolean

  Returns unknown[]

  Array of strings

exportObjectToString

• exportObjectToString(object, supportsValue?): Record<string, any>

• Export an object of values to an object of strings

  Parameters

  • object: Record<string, unknown>

    Object of values to export

  • supportsValue: ((it) => boolean) = ...

    Function to check if a value is supported and therefore should not be converted to a string

    • • (it): boolean

      • Parameters

        • it: unknown

        Returns boolean

  Returns Record<string, any>

  Object of strings

  Throws

  • Unsupported type

exportToString

• exportToString(value): string

• Export a value to a string

  Parameters

  • value: unknown

    Value to export

  Returns string

  • String representation of the value

  Throws

  • Unsupported type

importArrayFromString

• importArrayFromString(value): unknown[]

• Import an array of values from an array of strings

  Parameters

  • value: unknown[]

    Array of strings

  Returns unknown[]

  Array of values

  Throws

  • Unsupported type

importFromString

• importFromString(value): unknown

• Import a value from a string

  Parameters

  • value: string

    String representation of the value

  Returns unknown

  • Imported value

  Throws

  • Unsupported type

importObjectFromString

• importObjectFromString(value): Record<string, unknown>

• Import an object of values from an object of strings

  Parameters

  • value: Record<string, unknown>

    Object of strings

  Returns Record<string, unknown>

  Object of values

  Throws

  • Unsupported type

register

• register<T>(type, identifier, exportToString, importFromString): void

• Register a type in the conversion register

  Type Parameters

  • T extends TypeInformation<any, any, T>

  Parameters

  • type: T

    the type to register

  • identifier: string

    the identifier for the type

  • exportToString: ((value) => string)

    export to string function

    • • (value): string

      • Parameters

        • value: PrimitiveType<T>

        Returns string

  • importFromString: ((value) => PrimitiveType<T>)

    import from string function

    • • (value): PrimitiveType<T>

      • Parameters

        • value: string

        Returns PrimitiveType<T>

  Returns void