Class FixedNatClass

Represents an IDL fixed-width Nat(n)

Hierarchy

PrimitiveType<bigint | number>
- FixedNatClass

Index

Constructors

constructor

Properties

_bits

Accessors

name

Methods

Constructors

constructor

new FixedNatClass(_bits: number): FixedNatClass

Overrides PrimitiveType.constructor
- Defined in packages/candid/src/idl.ts:689
Parameters
- _bits: number
Returns FixedNatClass

Properties

Readonly _bits

_bits: number

Accessors

name

get name(): string

Overrides PrimitiveType.name
- Defined in packages/candid/src/idl.ts:731
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:693
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:697
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>): number | bigint

Overrides PrimitiveType.decodeValue
- Defined in packages/candid/src/idl.ts:721
Parameters
- b: PipeArrayBuffer
- t: Type<any>
Returns number | 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:716
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:712
Parameters
- x: number | bigint
Returns ArrayBuffer

valueToString

valueToString(x: number | bigint): string

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

Generated using TypeDoc