Class VariantClass

Represents an IDL Variant

param [fields]: mapping of function name to Type

Hierarchy

ConstructType<Record<string, any>>
- VariantClass

Index

Constructors

constructor

Properties

_fields

Accessors

name

Methods

Constructors

constructor

new VariantClass(fields?: Record<string, Type<any>>): VariantClass

Overrides ConstructType.constructor
- Defined in packages/candid/src/idl.ts:1164
Parameters
- fields: Record<string, Type<any>> = {}
Returns VariantClass

Properties

Private Readonly _fields

_fields: [string, Type<any>][]

Accessors

name

get name(): string

Overrides ConstructType.name
- Defined in packages/candid/src/idl.ts:1236
Returns string

Methods

_buildTypeTableImpl

_buildTypeTableImpl(typeTable: TypeTable): void

Overrides ConstructType._buildTypeTableImpl
- Defined in packages/candid/src/idl.ts:1205
Parameters
- typeTable: TypeTable
Returns void

accept

accept<D, R>(v: Visitor<D, R>, d: D): R

Overrides ConstructType.accept
- Defined in packages/candid/src/idl.ts:1169
Type Parameters
- D
- R
Parameters
- v: Visitor<D, R>
- d: D
Returns R

buildTypeTable

buildTypeTable(typeTable: TypeTable): void

Inherited from ConstructType.buildTypeTable
- Defined in packages/candid/src/idl.ts:192
Parameters
- typeTable: TypeTable
Returns void

checkType

checkType(t: Type<any>): ConstructType<Record<string, any>>

Inherited from ConstructType.checkType
- Defined in packages/candid/src/idl.ts:238
Parameters
- t: Type<any>
Returns ConstructType<Record<string, any>>

covariant

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

Overrides ConstructType.covariant
- Defined in packages/candid/src/idl.ts:1173
Assert that JavaScript's x is the proper type represented by this Type.

Parameters
- x: any
Returns x is Record<string, any>

decodeValue

decodeValue(b: PipeArrayBuffer, t: Type<any>): {}

Overrides ConstructType.decodeValue
- Defined in packages/candid/src/idl.ts:1217
Parameters
- b: PipeArrayBuffer
- t: Type<any>
Returns {}

display

display(): string

Overrides ConstructType.display
- Defined in packages/candid/src/idl.ts:1241
Returns string

encodeType

encodeType(typeTable: TypeTable): ArrayBuffer

Inherited from ConstructType.encodeType
- Defined in packages/candid/src/idl.ts:248
Implement I in the IDL spec. Encode this type for the type table.

Parameters
- typeTable: TypeTable
Returns ArrayBuffer

encodeValue

encodeValue(x: Record<string, any>): ArrayBuffer

Overrides ConstructType.encodeValue
- Defined in packages/candid/src/idl.ts:1191
Parameters
- x: Record<string, any>
Returns ArrayBuffer

valueToString

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

Overrides ConstructType.valueToString
- Defined in packages/candid/src/idl.ts:1248
Parameters
- x: Record<string, any>
Returns string

Generated using TypeDoc