PrincipalClass
Defined in: packages/candid/src/idl.ts:1676
Represents an IDL principal reference
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/candid/src/idl.ts:1708
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:1677
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:286
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:1685
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:246
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:279
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/candid/src/idl.ts:1689
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/candid/src/idl.ts:1703
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Overrides
Section titled “Overrides”display()
Section titled “display()”display():
string
Defined in: packages/candid/src/idl.ts:237
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”encodeType()
Section titled “encodeType()”encodeType():
Uint8Array
Defined in: packages/candid/src/idl.ts:1699
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/candid/src/idl.ts:1694
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/candid/src/idl.ts:1711
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/candid/src/idl.ts:1681
Parameters
Section titled “Parameters”instance
Section titled “instance”any
Returns
Section titled “Returns”instance is PrincipalClass