Class ServiceClass

Represents an IDL type.

Hierarchy (view full)

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

Index

Constructors

Properties

Accessors

Methods

display buildTypeTable checkType encodeType accept covariant encodeValue _buildTypeTableImpl decodeValue valueToString

Constructors

constructor

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

Properties

`Readonly` _fields

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

Accessors

name

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

Methods

display

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

buildTypeTable

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

checkType

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

encodeType

encodeType(typeTable): ArrayBuffer
Implement I in the IDL spec. Encode this type for the type table.
Parameters
- typeTable: TypeTable
Returns ArrayBuffer
Inherited from ConstructType.encodeType
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:76

accept

accept<D, R>(v, 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/cjs/idl.d.ts:362

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 ConstructType.covariant
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:363

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 ConstructType.encodeValue
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:364

_buildTypeTableImpl

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

decodeValue

decodeValue(b): types.Principal
Parameters
- b: utils.candid.PipeArrayBuffer
Returns types.Principal
Overrides ConstructType.decodeValue
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:366

valueToString

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