Class Type

constructor

• new Type(
      name: string,
      typeParameters?: Type[],
      cardinality?: TypeCardinality,
      metadata?: any,
  ): Type

• Parameters

  • name: string
  • typeParameters: Type[] = []
  • cardinality: TypeCardinality = ...
  • Optionalmetadata: any

  Returns Type

StaticClassName

belongsToTypesystem

• belongsToTypesystem(): void

• A special marker for types within the custom typesystem.

  Returns void

differs

• differs(other: Type): boolean

• Parameters

  • other: Type

  Returns boolean

equals

• equals(other: Type): boolean

• Parameters

  • other: Type

  Returns boolean

getCardinality

• getCardinality(): TypeCardinality

• Returns TypeCardinality

getClassHierarchy

• getClassHierarchy(): string[]

• Returns string[]

getClassName

• getClassName(): string

• Returns string

getFirstTypeParameter

• getFirstTypeParameter(): Type

• Returns Type

getFullyQualifiedName

• getFullyQualifiedName(): string

• Gets the fully qualified name of the type, to allow for better (efficient and non-ambiguous) type comparison within the custom typesystem.

  Returns string

getMetadata

• getMetadata(): any

• Returns any

getName

• getName(): string

• Returns string

getNamesOfDependencies

• getNamesOfDependencies(): string[]

• Returns string[]

getTypeParameters

• getTypeParameters(): Type[]

• Returns Type[]

hasClassOrSuperclass

• hasClassOrSuperclass(className: string): boolean

• Parameters

  • className: string

  Returns boolean

hasExactClass

• hasExactClass(className: string): boolean

• Parameters

  • className: string

  Returns boolean

hasMetadata

• hasMetadata(): boolean

• Returns boolean

isAssignableFrom

• isAssignableFrom(other: Type): boolean

• Inspired from: https://docs.microsoft.com/en-us/dotnet/api/system.type.isassignablefrom For (most) generics, type invariance is expected (assumed) - neither covariance, nor contravariance are supported yet (will be supported in a next release).

  One exception though: for OptionType, we simulate covariance for missing (not provided) values. For example, Option is assignable from Option<?>. For more details, see the implementation of OptionType and @OptionalType.

  Also see:

  • https://en.wikipedia.org/wiki/Covariance_and_contravariance_(computer_science)
  • https://docs.microsoft.com/en-us/dotnet/standard/generics/covariance-and-contravariance

  Parameters

  • other: Type

  Returns boolean

isGenericType

• isGenericType(): boolean

• Returns boolean

toJSON

• toJSON(): any

• Converts the account to a pretty, plain JavaScript object.

  Returns any

toString

• toString(): string

• Generates type expressions similar to mx-sdk-rs.

  Returns string

valueOf

• valueOf(): string

• Returns string

Staticequals

• equals(a: Type, b: Type): boolean

• Parameters

  • a: Type
  • b: Type

  Returns boolean

StaticequalsMany

• equalsMany(a: Type[], b: Type[]): boolean

• Parameters

  • a: Type[]
  • b: Type[]

  Returns boolean

StaticisAssignableFromMany

• isAssignableFromMany(a: Type[], b: Type[]): boolean

• Parameters

  • a: Type[]
  • b: Type[]

  Returns boolean