Class PrincipalClass

Represents an IDL principal reference

Hierarchy (view full)

types.IDL.PrimitiveType<types.Principal>
- PrincipalClass

Index

Constructors

Accessors

Methods

display buildTypeTable checkType _buildTypeTableImpl accept covariant encodeValue encodeType decodeValue valueToString

Constructors

constructor

new PrincipalClass(): types.IDL.PrincipalClass
Returns types.IDL.PrincipalClass
Inherited from PrimitiveType.constructor

Accessors

name

get name(): string
Returns string
Overrides PrimitiveType.name
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:334

Methods

display

display(): string
Returns string
Inherited from PrimitiveType.display
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:47

buildTypeTable

buildTypeTable(typeTable): void
Parameters
- typeTable: TypeTable
Returns void
Inherited from PrimitiveType.buildTypeTable
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:49

checkType

checkType(t): types.IDL.Type<any>
Parameters
- t: types.IDL.Type<any>
Returns types.IDL.Type<any>
Inherited from PrimitiveType.checkType
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:71

_buildTypeTableImpl

_buildTypeTableImpl(typeTable): void
Parameters
- typeTable: TypeTable
Returns void
Inherited from PrimitiveType._buildTypeTableImpl
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:72

accept

accept<D, R>(v, d): R
Type Parameters
- D
- R
Parameters
- v: types.IDL.Visitor<D, R>
- d: D
Returns R
Overrides PrimitiveType.accept
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:329

covariant

covariant(x): x is types.Principal
Assert that JavaScript's x is the proper type represented by this Type.
Parameters
- x: any
Returns x is types.Principal
Overrides PrimitiveType.covariant
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:330

encodeValue

encodeValue(x): ArrayBuffer
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Parameters
- x: types.Principal
Returns ArrayBuffer
Overrides PrimitiveType.encodeValue
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:331

encodeType

encodeType(): ArrayBuffer
Implement I in the IDL spec. Encode this type for the type table.

Returns ArrayBuffer
Overrides PrimitiveType.encodeType
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:332

decodeValue

decodeValue(b, t): types.Principal
Parameters
- b: utils.candid.PipeArrayBuffer
- t: types.IDL.Type<any>
Returns types.Principal
Overrides PrimitiveType.decodeValue
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:333

valueToString

valueToString(x): string
Parameters
- x: types.Principal
Returns string
Overrides PrimitiveType.valueToString
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:335