UnknownClass
Defined in: packages/candid/src/idl.ts:329
Represents an IDL Unknown, a placeholder type for deserialization only.
When decoding a value as Unknown, all fields will be retained but the names are only available in
hashed form.
A deserialized unknown will offer it’s actual type by calling the type() function.
Unknown cannot be serialized and attempting to do so will throw an error.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UnknownClass():
UnknownClass
Returns
Section titled “Returns”UnknownClass
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get name():
string
Defined in: packages/candid/src/idl.ts:395
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:330
Returns
Section titled “Returns”IdlTypeName
Overrides
Section titled “Overrides”Methods
Section titled “Methods”_buildTypeTableImpl()
Section titled “_buildTypeTableImpl()”
protected_buildTypeTableImpl():void
Defined in: packages/candid/src/idl.ts:391
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”accept()
Section titled “accept()”accept<
D,R>(v,d):R
Defined in: packages/candid/src/idl.ts:342
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):Type
Defined in: packages/candid/src/idl.ts:338
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Overrides
Section titled “Overrides”covariant()
Section titled “covariant()”covariant(
x):x is any
Defined in: packages/candid/src/idl.ts:346
Assert that JavaScript’s x is the proper type represented by this
Type.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”x is any
Overrides
Section titled “Overrides”decodeValue()
Section titled “decodeValue()”decodeValue(
b,t):any
Defined in: packages/candid/src/idl.ts:362
Parameters
Section titled “Parameters”Returns
Section titled “Returns”any
Overrides
Section titled “Overrides”display()
Section titled “display()”display():
string
Defined in: packages/candid/src/idl.ts:208
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”encodeType()
Section titled “encodeType()”encodeType():
never
Defined in: packages/candid/src/idl.ts:358
Implement I in the IDL spec.
Encode this type for the type table.
Returns
Section titled “Returns”never
Overrides
Section titled “Overrides”encodeValue()
Section titled “encodeValue()”encodeValue():
never
Defined in: packages/candid/src/idl.ts:350
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Returns
Section titled “Returns”never
Overrides
Section titled “Overrides”valueToString()
Section titled “valueToString()”valueToString():
never
Defined in: packages/candid/src/idl.ts:354
Returns
Section titled “Returns”never
Overrides
Section titled “Overrides”[hasInstance]()
Section titled “[hasInstance]()”
static[hasInstance](instance):instance is UnknownClass
Defined in: packages/candid/src/idl.ts:334
Parameters
Section titled “Parameters”instance
Section titled “instance”any
Returns
Section titled “Returns”instance is UnknownClass