Class FuncClass

Represents an IDL function reference.

param argTypes: Argument types.
param retTypes: Return types.
param annotations: Function annotations.

Hierarchy

ConstructType<[PrincipalId, string]>
- FuncClass

Index

Constructors

constructor

Properties

Accessors

name

Methods

Constructors

constructor

new FuncClass(argTypes: Type<any>[], retTypes: Type<any>[], annotations?: string[]): FuncClass

Overrides ConstructType.constructor
- Defined in packages/candid/src/idl.ts:1395
Parameters
- argTypes: Type<any>[]
- retTypes: Type<any>[]
- annotations: string[] = []
Returns FuncClass

Properties

annotations

annotations: string[] = []

argTypes

argTypes: Type<any>[]

retTypes

retTypes: Type<any>[]

Accessors

name

get name(): string

Overrides ConstructType.name
- Defined in packages/candid/src/idl.ts:1448
Returns string

Methods

_buildTypeTableImpl

_buildTypeTableImpl(T: TypeTable): void

Overrides ConstructType._buildTypeTableImpl
- Defined in packages/candid/src/idl.ts:1418
Parameters
- T: TypeTable
Returns void

accept

accept<D, R>(v: Visitor<D, R>, d: D): R

Overrides ConstructType.accept
- Defined in packages/candid/src/idl.ts:1399
Type Parameters
- D
- R
Parameters
- v: Visitor<D, R>
- d: D
Returns R

buildTypeTable

buildTypeTable(typeTable: TypeTable): void

Inherited from ConstructType.buildTypeTable
- Defined in packages/candid/src/idl.ts:192
Parameters
- typeTable: TypeTable
Returns void

checkType

checkType(t: Type<any>): ConstructType<[Principal, string]>

Inherited from ConstructType.checkType
- Defined in packages/candid/src/idl.ts:238
Parameters
- t: Type<any>
Returns ConstructType<[Principal, string]>

covariant

covariant(x: any): x is [Principal, string]

Overrides ConstructType.covariant
- Defined in packages/candid/src/idl.ts:1402
Assert that JavaScript's x is the proper type represented by this Type.

Parameters
- x: any
Returns x is [Principal, string]

decodeValue

decodeValue(b: PipeArrayBuffer): [Principal, string]

Overrides ConstructType.decodeValue
- Defined in packages/candid/src/idl.ts:1433
Parameters
- b: PipeArrayBuffer
Returns [Principal, string]

display

display(): string

Overrides ConstructType.display
- Defined in packages/candid/src/idl.ts:1459
Returns string

Private encodeAnnotation

encodeAnnotation(ann: string): ArrayBuffer

- Defined in packages/candid/src/idl.ts:1466
Parameters
- ann: string
Returns ArrayBuffer

encodeType

encodeType(typeTable: TypeTable): ArrayBuffer

Inherited from ConstructType.encodeType
- Defined in packages/candid/src/idl.ts:248
Implement I in the IDL spec. Encode this type for the type table.

Parameters
- typeTable: TypeTable
Returns ArrayBuffer

encodeValue

encodeValue(__namedParameters: [Principal, string]): ArrayBuffer

Overrides ConstructType.encodeValue
- Defined in packages/candid/src/idl.ts:1408
Parameters
- __namedParameters: [Principal, string]
Returns ArrayBuffer

valueToString

valueToString(__namedParameters: [Principal, string]): string

Overrides ConstructType.valueToString
- Defined in packages/candid/src/idl.ts:1455
Parameters
- __namedParameters: [Principal, string]
Returns string

Static argsToString

argsToString(types: Type<any>[], v: any[]): string

- Defined in packages/candid/src/idl.ts:1388
Parameters
- types: Type<any>[]
- v: any[]
Returns string

Generated using TypeDoc