ServiceClass
Defined in: packages/candid/src/idl.ts:1821
Represents an IDL type.
Type Parameters
Section titled “Type Parameters”K extends string = string
Fields
Section titled “Fields”Fields extends GenericIdlServiceFields = GenericIdlServiceFields
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ServiceClass<
K,Fields>(fields):ServiceClass<K,Fields>
Defined in: packages/candid/src/idl.ts:1834
Parameters
Section titled “Parameters”fields
Section titled “fields”Fields
Returns
Section titled “Returns”ServiceClass<K, Fields>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_fields
Section titled “_fields”
readonly_fields: [K,Fields[K]][]
Defined in: packages/candid/src/idl.ts:1833
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get name():
string
Defined in: packages/candid/src/idl.ts:1882
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:1825
Returns
Section titled “Returns”IdlTypeName
Overrides
Section titled “Overrides”Methods
Section titled “Methods”_buildTypeTableImpl()
Section titled “_buildTypeTableImpl()”_buildTypeTableImpl(
T):void
Defined in: packages/candid/src/idl.ts:1860
Parameters
Section titled “Parameters”TypeTable
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”ConstructType._buildTypeTableImpl
accept()
Section titled “accept()”accept<
D,R>(v,d):R
Defined in: packages/candid/src/idl.ts:1846
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:217
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):ConstructType<Principal>
Defined in: packages/candid/src/idl.ts:264
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:1849
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:1873
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:208
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”encodeType()
Section titled “encodeType()”encodeType(
typeTable):Uint8Array<ArrayBufferLike>
Defined in: packages/candid/src/idl.ts:274
Implement I in the IDL spec.
Encode this type for the type table.
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike>
Inherited from
Section titled “Inherited from”encodeValue()
Section titled “encodeValue()”encodeValue(
x):Uint8Array
Defined in: packages/candid/src/idl.ts:1854
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”fieldsAsObject()
Section titled “fieldsAsObject()”fieldsAsObject():
Fields
Defined in: packages/candid/src/idl.ts:1891
Returns
Section titled “Returns”Fields
valueToString()
Section titled “valueToString()”valueToString(
x):string
Defined in: packages/candid/src/idl.ts:1887
Parameters
Section titled “Parameters”Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”[hasInstance]()
Section titled “[hasInstance]()”
static[hasInstance](instance):instance is ServiceClass<string, GenericIdlServiceFields>
Defined in: packages/candid/src/idl.ts:1829
Parameters
Section titled “Parameters”instance
Section titled “instance”any
Returns
Section titled “Returns”instance is ServiceClass<string, GenericIdlServiceFields>