NatClass
Defined in: packages/candid/src/idl.ts:621
Represents an IDL Nat
PrimitiveType<bigint>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NatClass():
NatClass
Returns
Section titled “Returns”NatClass
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:654
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:622
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:257
Parameters
Section titled “Parameters”_typeTable
Section titled “_typeTable”TypeTable
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”PrimitiveType._buildTypeTableImpl
accept()
Section titled “accept()”accept<
D,R>(v,d):R
Defined in: packages/candid/src/idl.ts:630
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:250
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”covariant()
Section titled “covariant()”covariant(
x):x is bigint
Defined in: packages/candid/src/idl.ts:634
Assert that JavaScript’s x is the proper type represented by this
Type.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”x is bigint
Overrides
Section titled “Overrides”decodeValue()
Section titled “decodeValue()”decodeValue(
b,t):bigint
Defined in: packages/candid/src/idl.ts:649
Parameters
Section titled “Parameters”Returns
Section titled “Returns”bigint
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():
Uint8Array<ArrayBufferLike>
Defined in: packages/candid/src/idl.ts:645
Implement I in the IDL spec.
Encode this type for the type table.
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike>
Overrides
Section titled “Overrides”encodeValue()
Section titled “encodeValue()”encodeValue(
x):Uint8Array
Defined in: packages/candid/src/idl.ts:641
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Parameters
Section titled “Parameters”number | bigint
Returns
Section titled “Returns”Uint8Array
Overrides
Section titled “Overrides”valueToString()
Section titled “valueToString()”valueToString(
x):string
Defined in: packages/candid/src/idl.ts:658
Parameters
Section titled “Parameters”bigint
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”[hasInstance]()
Section titled “[hasInstance]()”
static[hasInstance](instance):instance is NatClass
Defined in: packages/candid/src/idl.ts:626
Parameters
Section titled “Parameters”instance
Section titled “instance”any
Returns
Section titled “Returns”instance is NatClass