Class VariantClass

constructor

• new VariantClass(
      fields?: Record<string, types.IDL.Type<any>>,
  ): types.IDL.VariantClass

  Parameters

  • Optionalfields: Record<string, types.IDL.Type<any>>

  Returns types.IDL.VariantClass

Readonly_fields

typeName

• get typeName(): IdlTypeName

  Returns IdlTypeName

name

• get name(): string

  Returns string

alternativesAsObject

• get alternativesAsObject(): Record<number, types.IDL.Type>

  Returns Record<number, types.IDL.Type>

Static[hasInstance]

• "[hasInstance]"(instance: any): instance is types.IDL.VariantClass

  Parameters

  • instance: any

  Returns instance is types.IDL.VariantClass

accept

• accept<D, R>(v: types.IDL.Visitor<D, R>, d: D): R

  Type Parameters

  • D
  • R

  Parameters

  • v: types.IDL.Visitor<D, R>
  • d: D

  Returns R

covariant

• covariant(x: any): x is Record<string, any>

  Assert that JavaScript's x is the proper type represented by this Type.

  Parameters

  • x: any

  Returns x is Record<string, any>

encodeValue

• encodeValue(x: Record<string, any>): Uint8Array<ArrayBufferLike>
  Internal

  Encode the value. This needs to be public because it is used by encodeValue() from different types.

  Parameters

  • x: Record<string, any>

  Returns Uint8Array<ArrayBufferLike>

_buildTypeTableImpl

• _buildTypeTableImpl(typeTable: TypeTable): void

  Parameters

  • typeTable: TypeTable

  Returns void

decodeValue

• decodeValue(
      b: utils.candid.PipeArrayBuffer,
      t: types.IDL.Type,
  ): { [x: string]: any }

  Parameters

  • b: utils.candid.PipeArrayBuffer
  • t: types.IDL.Type

  Returns { [x: string]: any }

display

• display(): string

  Returns string

valueToString

• valueToString(x: Record<string, any>): string

  Parameters

  • x: Record<string, any>

  Returns string