Class OptClass<T>

Represents an IDL Option

Param: t

Type Parameters

T

Hierarchy (View Summary)

types.IDL.ConstructType<[T] | []>
- OptClass

Index

Constructors

Properties

Accessors

Methods

buildTypeTable checkType encodeType [hasInstance] accept covariant encodeValue _buildTypeTableImpl decodeValue display valueToString

Constructors

constructor

new OptClass<T>(_type: types.IDL.Type<T>): types.IDL.OptClass<T>
Type Parameters
- T
Parameters
- _type: types.IDL.Type<T>
Returns types.IDL.OptClass<T>
Overrides ConstructType.constructor
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:296

Properties

_type

_type: types.IDL.Type<T>

Accessors

typeName

get typeName(): IdlTypeName
Returns IdlTypeName
Overrides ConstructType.typeName
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:294

name

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

Methods

buildTypeTable

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

checkType

checkType(t: types.IDL.Type): types.IDL.ConstructType<[] | [T]>
Parameters
- t: types.IDL.Type
Returns types.IDL.ConstructType<[] | [T]>
Inherited from ConstructType.checkType
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:98

encodeType

encodeType(typeTable: TypeTable): Uint8Array<ArrayBufferLike>
Implement I in the IDL spec. Encode this type for the type table.
Parameters
- typeTable: TypeTable
Returns Uint8Array<ArrayBufferLike>
Inherited from ConstructType.encodeType
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:99

`Static`[hasInstance]

"[hasInstance]"<T>(instance: any): instance is types.IDL.OptClass<T>
Type Parameters
- T
Parameters
- instance: any
Returns instance is types.IDL.OptClass<T>
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:295

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
Overrides ConstructType.accept
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:297

covariant

covariant(x: any): x is [] | [T]
Assert that JavaScript's x is the proper type represented by this Type.
Parameters
- x: any
Returns x is [] | [T]
Overrides ConstructType.covariant
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:298

encodeValue

encodeValue(x: [] | [T]): Uint8Array
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Parameters
- x: [] | [T]
Returns Uint8Array
Overrides ConstructType.encodeValue
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:299

_buildTypeTableImpl

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

decodeValue

decodeValue(b: utils.candid.PipeArrayBuffer, t: types.IDL.Type): [] | [T]
Parameters
- b: utils.candid.PipeArrayBuffer
- t: types.IDL.Type
Returns [] | [T]
Overrides ConstructType.decodeValue
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:301

display

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

valueToString

valueToString(x: [] | [T]): string
Parameters
- x: [] | [T]
Returns string
Overrides ConstructType.valueToString
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:304