Class DataValueProperties

A class holding properties for a data value.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ContentType DataType GetPropertyValue HasPropertyValue

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

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

  • Equals(other): boolean

  • Indicates whether the current object is equal to another object of the same type.

    Parameters

    Returns boolean

    true if the current object is equal to the other parameter; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

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

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

ContentType

  • get ContentType(): string

  • Gets the content type for the data value.

    Returns string

    Since

    2.0

DataType

  • get DataType(): DataType

  • Gets the data type of the data value.

    Returns DataType

    Since

    2.0

GetPropertyValue

  • GetPropertyValue(propertyName): unknown

  • Gets the value of a named property.

    Parameters

    • propertyName: string | String

      The name of the property.

    Returns unknown

    The property value.

    Since

    2.0

HasPropertyValue

  • HasPropertyValue(propertyName): boolean

  • Checks whether a property with a given name exists.

    Parameters

    • propertyName: string | String

      The name of the property.

    Returns boolean

    true if the property exists, false otherwise.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability