OptClass
Defined in: packages/candid/src/idl.ts:1065
Represents an IDL Option
Extends
Section titled “Extends”ConstructType<[T] | []>
Type Parameters
Section titled “Type Parameters”T
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OptClass<
T>(_type):OptClass<T>
Defined in: packages/candid/src/idl.ts:1074
Parameters
Section titled “Parameters”Type<T>
Returns
Section titled “Returns”OptClass<T>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_type:
Type<T>
Defined in: packages/candid/src/idl.ts:1074
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get name():
string
Defined in: packages/candid/src/idl.ts:1179
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”typeName
Section titled “typeName”Get Signature
Section titled “Get Signature”get typeName():
IdlTypeName
Defined in: packages/candid/src/idl.ts:1066
Returns
Section titled “Returns”IdlTypeName
Overrides
Section titled “Overrides”Methods
Section titled “Methods”_buildTypeTableImpl()
Section titled “_buildTypeTableImpl()”_buildTypeTableImpl(
typeTable):void
Defined in: packages/candid/src/idl.ts:1102
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”ConstructType._buildTypeTableImpl
accept()
Section titled “accept()”accept<
D,R>(v,d):R
Defined in: packages/candid/src/idl.ts:1078
Type Parameters
Section titled “Type Parameters”D
R
Parameters
Section titled “Parameters”Visitor<D, R>
D
Returns
Section titled “Returns”R
Overrides
Section titled “Overrides”buildTypeTable()
Section titled “buildTypeTable()”buildTypeTable(
typeTable):void
Defined in: packages/candid/src/idl.ts:217
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”checkType()
Section titled “checkType()”checkType(
t):ConstructType<[] | [T]>
Defined in: packages/candid/src/idl.ts:264
Parameters
Section titled “Parameters”Returns
Section titled “Returns”ConstructType<[] | [T]>
Inherited from
Section titled “Inherited from”covariant()
Section titled “covariant()”covariant(
x): x is [] | [T]
Defined in: packages/candid/src/idl.ts:1082
Assert that JavaScript’s x is the proper type represented by this
Type.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”x is [] | [T]
Overrides
Section titled “Overrides”decodeValue()
Section titled “decodeValue()”decodeValue(
b,t): [] | [T]
Defined in: packages/candid/src/idl.ts:1110
Parameters
Section titled “Parameters”Returns
Section titled “Returns”[] | [T]
Overrides
Section titled “Overrides”display()
Section titled “display()”display():
string
Defined in: packages/candid/src/idl.ts:1183
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”encodeType()
Section titled “encodeType()”encodeType(
typeTable):Uint8Array<ArrayBufferLike>
Defined in: packages/candid/src/idl.ts:274
Implement I in the IDL spec.
Encode this type for the type table.
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike>
Inherited from
Section titled “Inherited from”encodeValue()
Section titled “encodeValue()”encodeValue(
x):Uint8Array
Defined in: packages/candid/src/idl.ts:1094
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Parameters
Section titled “Parameters”[] | [T]
Returns
Section titled “Returns”Uint8Array
Overrides
Section titled “Overrides”valueToString()
Section titled “valueToString()”valueToString(
x):string
Defined in: packages/candid/src/idl.ts:1187
Parameters
Section titled “Parameters”[] | [T]
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”[hasInstance]()
Section titled “[hasInstance]()”
static[hasInstance]<T>(instance):instance is OptClass<T>
Defined in: packages/candid/src/idl.ts:1070
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”instance
Section titled “instance”any
Returns
Section titled “Returns”instance is OptClass<T>