Class ServiceClass

Represents an IDL type.

Hierarchy (View Summary)

types.IDL.ConstructType<types.Principal>
- ServiceClass

Index

Constructors

Properties

Accessors

Methods

display buildTypeTable checkType encodeType [hasInstance] accept covariant encodeValue _buildTypeTableImpl decodeValue valueToString fieldsAsObject

Constructors

constructor

new ServiceClass(
fields: Record<string, types.IDL.FuncClass>,
): types.IDL.ServiceClass
Parameters
- fields: Record<string, types.IDL.FuncClass>
Returns types.IDL.ServiceClass
Overrides ConstructType.constructor
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:426

Properties

`Readonly`_fields

_fields: [string, types.IDL.FuncClass][]

Accessors

typeName

get typeName(): IdlTypeName
Returns IdlTypeName
Overrides ConstructType.typeName
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:423

name

get name(): string
Returns string
Overrides ConstructType.name
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:432

Methods

display

display(): string
Returns string
Inherited from ConstructType.display
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:70

buildTypeTable

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

checkType

checkType(t: types.IDL.Type): types.IDL.ConstructType<types.Principal>
Parameters
- t: types.IDL.Type
Returns types.IDL.ConstructType<types.Principal>
Inherited from ConstructType.checkType
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:98

encodeType

encodeType(typeTable: TypeTable): Uint8Array<ArrayBufferLike>
Implement I in the IDL spec. Encode this type for the type table.
Parameters
- typeTable: TypeTable
Returns Uint8Array<ArrayBufferLike>
Inherited from ConstructType.encodeType
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:99

`Static`[hasInstance]

"[hasInstance]"(instance: any): instance is types.IDL.ServiceClass
Parameters
- instance: any
Returns instance is types.IDL.ServiceClass
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:424

accept

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

covariant

covariant(x: any): 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 ConstructType.covariant
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:428

encodeValue

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

_buildTypeTableImpl

_buildTypeTableImpl(T: TypeTable): void
Parameters
- T: TypeTable
Returns void
Overrides ConstructType._buildTypeTableImpl
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:430

decodeValue

decodeValue(b: utils.candid.PipeArrayBuffer, t: types.IDL.Type): types.Principal
Parameters
- b: utils.candid.PipeArrayBuffer
- t: types.IDL.Type
Returns types.Principal
Overrides ConstructType.decodeValue
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:431

valueToString

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

fieldsAsObject

fieldsAsObject(): Record<string, types.IDL.Type<any>>
Returns Record<string, types.IDL.Type<any>>
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:434