About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

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 Summary)

IInterfaceBase
- IDataFormatter

Implemented by

Index

Methods

Default capability

Format FormatInvalid Parse TryParse

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from IInterfaceBase.Cast

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from IInterfaceBase.TryCast

Default capability

Format

Format(obj: any): 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: any): 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 | String): 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: string | String): 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: string | String, result: OutParam<System.Object>): boolean
Converts a string representation to an object. A return value indicates whether the conversion succeeded or failed.
Parameters
- str: string | String
  The string to convert.
- result: OutParam<System.Object>
  The object that is the result of the conversion.
Returns boolean
true if str was converted successfully; otherwise, false.

Since
2.0