Class NatClass

Represents an IDL Nat

Hierarchy

PrimitiveType<bigint>
- NatClass

Index

Constructors

constructor

Accessors

name

Methods

Constructors

constructor

new NatClass(): NatClass

Inherited from PrimitiveType.constructor
Returns NatClass

Accessors

name

get name(): string

Overrides PrimitiveType.name
- Defined in packages/candid/src/idl.ts:564
Returns string

Methods

_buildTypeTableImpl

_buildTypeTableImpl(typeTable: TypeTable): void

Inherited from PrimitiveType._buildTypeTableImpl
- Defined in packages/candid/src/idl.ts:231
Parameters
- typeTable: TypeTable
Returns void

accept

accept<D, R>(v: Visitor<D, R>, d: D): R

Overrides PrimitiveType.accept
- Defined in packages/candid/src/idl.ts:540
Type Parameters
- D
- R
Parameters
- v: Visitor<D, R>
- d: D
Returns R

buildTypeTable

buildTypeTable(typeTable: TypeTable): void

Inherited from PrimitiveType.buildTypeTable
- Defined in packages/candid/src/idl.ts:192
Parameters
- typeTable: TypeTable
Returns void

checkType

checkType(t: Type<any>): Type<any>

Inherited from PrimitiveType.checkType
- Defined in packages/candid/src/idl.ts:224
Parameters
- t: Type<any>
Returns Type<any>

covariant

covariant(x: any): x is bigint

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

Parameters
- x: any
Returns x is bigint

decodeValue

decodeValue(b: PipeArrayBuffer, t: Type<any>): bigint

Overrides PrimitiveType.decodeValue
- Defined in packages/candid/src/idl.ts:559
Parameters
- b: PipeArrayBuffer
- t: Type<any>
Returns bigint

display

display(): string

Inherited from PrimitiveType.display
- Defined in packages/candid/src/idl.ts:183
Returns string

encodeType

encodeType(): ArrayBuffer

Overrides PrimitiveType.encodeType
- Defined in packages/candid/src/idl.ts:555
Implement I in the IDL spec. Encode this type for the type table.

Returns ArrayBuffer

encodeValue

encodeValue(x: number | bigint): ArrayBuffer

Overrides PrimitiveType.encodeValue
- Defined in packages/candid/src/idl.ts:551
Parameters
- x: number | bigint
Returns ArrayBuffer

valueToString

valueToString(x: bigint): string

Overrides PrimitiveType.valueToString
- Defined in packages/candid/src/idl.ts:568
Parameters
- x: bigint
Returns string

Generated using TypeDoc