PrincipalClass
Defined in: packages/core/src/candid/idl.ts:1727
Represents an IDL principal reference
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PrincipalClass():
PrincipalClass
Returns
Section titled “Returns”PrincipalClass
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get name():
string
Defined in: packages/core/src/candid/idl.ts:1761
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/core/src/candid/idl.ts:1728
Returns
Section titled “Returns”IdlTypeName
Overrides
Section titled “Overrides”Methods
Section titled “Methods”_buildTypeTableImpl()
Section titled “_buildTypeTableImpl()”_buildTypeTableImpl(
_typeTable):void
Defined in: packages/core/src/candid/idl.ts:300
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/core/src/candid/idl.ts:1736
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/core/src/candid/idl.ts:260
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/core/src/candid/idl.ts:293
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”covariant()
Section titled “covariant()”covariant(
x):x is Principal
Defined in: packages/core/src/candid/idl.ts:1740
Assert that JavaScript’s x is the proper type represented by this
Type.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”x is Principal
Overrides
Section titled “Overrides”decodeValue()
Section titled “decodeValue()”decodeValue(
b,t):Principal
Defined in: packages/core/src/candid/idl.ts:1756
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Overrides
Section titled “Overrides”display()
Section titled “display()”display():
string
Defined in: packages/core/src/candid/idl.ts:251
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”encodeType()
Section titled “encodeType()”encodeType():
Uint8Array
Defined in: packages/core/src/candid/idl.ts:1752
Implement I in the IDL spec.
Encode this type for the type table.
Returns
Section titled “Returns”Uint8Array
Overrides
Section titled “Overrides”encodeValue()
Section titled “encodeValue()”encodeValue(
x):Uint8Array
Defined in: packages/core/src/candid/idl.ts:1747
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Uint8Array
Overrides
Section titled “Overrides”valueToString()
Section titled “valueToString()”valueToString(
x):string
Defined in: packages/core/src/candid/idl.ts:1764
Parameters
Section titled “Parameters”Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”[hasInstance]()
Section titled “[hasInstance]()”
static[hasInstance](instance):instance is PrincipalClass
Defined in: packages/core/src/candid/idl.ts:1732
Parameters
Section titled “Parameters”instance
Section titled “instance”any
Returns
Section titled “Returns”instance is PrincipalClass