Class OptClass<T>

Represents an IDL Option

param t

Type Parameters

T

Hierarchy

ConstructType<[T] | []>
- OptClass

Index

Constructors

constructor

Properties

_type

Accessors

name

Methods

Constructors

constructor

new OptClass<T>(_type: Type<T>): OptClass<T>

Overrides ConstructType.constructor
- Defined in packages/candid/src/idl.ts:880
Type Parameters
- T
Parameters
- _type: Type<T>
Returns OptClass<T>

Properties

Protected _type

_type: Type<T>

Accessors

name

get name(): string

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

Methods

_buildTypeTableImpl

_buildTypeTableImpl(typeTable: TypeTable): void

Overrides ConstructType._buildTypeTableImpl
- Defined in packages/candid/src/idl.ts:908
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:884
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<[] | [T]>

Inherited from ConstructType.checkType
- Defined in packages/candid/src/idl.ts:238
Parameters
- t: Type<any>
Returns ConstructType<[] | [T]>

covariant

covariant(x: any): x is [] | [T]

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

Parameters
- x: any
Returns x is [] | [T]

decodeValue

decodeValue(b: PipeArrayBuffer, t: Type<any>): [] | [T]

Overrides ConstructType.decodeValue
- Defined in packages/candid/src/idl.ts:916
Parameters
- b: PipeArrayBuffer
- t: Type<any>
Returns [] | [T]

display

display(): string

Overrides ConstructType.display
- Defined in packages/candid/src/idl.ts:935
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: [] | [T]): ArrayBuffer

Overrides ConstructType.encodeValue
- Defined in packages/candid/src/idl.ts:900
Parameters
- x: [] | [T]
Returns ArrayBuffer

valueToString

valueToString(x: [] | [T]): string

Overrides ConstructType.valueToString
- Defined in packages/candid/src/idl.ts:939
Parameters
- x: [] | [T]
Returns string

Generated using TypeDoc