Interface IDataFormatter

Converts an object to and from a string representation.

Since

2.0

interface IDataFormatter {
    Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1;
    Format(obj: any): string;
    Format(obj: any): string;
    FormatInvalid(error: string | String): string;
    Parse(str: string | String): unknown;
    TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1;
    TryParse(str: string | String, result: OutParam<System.Object>): boolean;
}

Hierarchy (view full)

Implemented by

Methods

Cast TryCast

Default capability

Format FormatInvalid Parse TryParse

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

Default capability

Format

  • Format(obj): string

  • Converts an object to a string representation.

    Parameters

    • obj: any

      The object to convert.

    Returns string

    A string representation.

    Since

    2.0

  • Format(obj): string

  • Converts an object to a string representation.

    Parameters

    • obj: any

      The object to convert.

    Returns string

    A string representation.

    Since

    2.0

FormatInvalid

  • FormatInvalid(error): string

  • Formats an invalid value with an optional error string.

    Parameters

    • error: string | String

      An error string. Optional (may be null).

    Returns string

    A string value

    Since

    2.0

Parse

  • Parse(str): unknown

  • Converts a string representation to an object.

    Parameters

    • str: string | String

      The string to convert.

    Returns unknown

    An object.

    Since

    2.0

TryParse

  • TryParse(str, result): boolean

  • Converts a string representation to an object. A return value indicates whether the conversion succeeded or failed.

    Parameters

    Returns boolean

    true if str was converted successfully; otherwise, false.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability