Class VariantClass

Represents an IDL Variant

Param: fields

mapping of function name to Type

Hierarchy (view full)

types.IDL.ConstructType<Record<string, any>>
- VariantClass

Index

Constructors

Properties

Accessors

Methods

buildTypeTable checkType encodeType accept covariant encodeValue _buildTypeTableImpl decodeValue display valueToString

Constructors

constructor

new VariantClass(fields?): types.IDL.VariantClass
Parameters
- Optional fields: Record<string, types.IDL.Type<any>>
Returns types.IDL.VariantClass
Overrides ConstructType.constructor
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:294

Properties

`Private` `Readonly` _fields

_fields: any

Accessors

name

get name(): string
Returns string
Overrides ConstructType.name
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:302

Methods

buildTypeTable

buildTypeTable(typeTable): void
Parameters
- typeTable: TypeTable
Returns void
Inherited from ConstructType.buildTypeTable
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:49

checkType

checkType(t): types.IDL.ConstructType<Record<string, any>>
Parameters
- t: types.IDL.Type<any>
Returns types.IDL.ConstructType<Record<string, any>>
Inherited from ConstructType.checkType
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:75

encodeType

encodeType(typeTable): ArrayBuffer
Implement I in the IDL spec. Encode this type for the type table.
Parameters
- typeTable: TypeTable
Returns ArrayBuffer
Inherited from ConstructType.encodeType
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:76

accept

accept<D, R>(v, d): R
Type Parameters
- D
- R
Parameters
- v: types.IDL.Visitor<D, R>
- d: D
Returns R
Overrides ConstructType.accept
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:295

covariant

covariant(x): 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>
Overrides ConstructType.covariant
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:296

encodeValue

encodeValue(x): ArrayBuffer
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Parameters
- x: Record<string, any>
Returns ArrayBuffer
Overrides ConstructType.encodeValue
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:297

_buildTypeTableImpl

_buildTypeTableImpl(typeTable): void
Parameters
- typeTable: TypeTable
Returns void
Overrides ConstructType._buildTypeTableImpl
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:298

decodeValue

decodeValue(b, t): {
[x: string]: any;
}
Parameters
- b: utils.candid.PipeArrayBuffer
- t: types.IDL.Type<any>
Returns {
[x: string]: any;
}
- [x: string]: any
Overrides ConstructType.decodeValue
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:299

display

display(): string
Returns string
Overrides ConstructType.display
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:303

valueToString

valueToString(x): string
Parameters
- x: Record<string, any>
Returns string
Overrides ConstructType.valueToString
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:304