Class FuncClass

Represents an IDL function reference.

param: Argument types.
param: Return types.
param: 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 src/utils/idl.ts:1236
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

- Defined in src/utils/idl.ts:1304
Returns string

Methods

_buildTypeTableImpl

_buildTypeTableImpl(T: TypeTable): void

Overrides ConstructType._buildTypeTableImpl
- Defined in src/utils/idl.ts:1268
Parameters
- T: TypeTable
Returns void

accept

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

Overrides ConstructType.accept
- Defined in src/utils/idl.ts:1244
Type parameters
- D
- R
Parameters
- v: Visitor<D, R>
- d: D
Returns R

buildTypeTable

buildTypeTable(typeTable: TypeTable): void

Inherited from ConstructType.buildTypeTable
- Defined in src/utils/idl.ts:212
Parameters
- typeTable: TypeTable
Returns void

checkType

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

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

covariant

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

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

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

decodeValue

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

Overrides ConstructType.decodeValue
- Defined in src/utils/idl.ts:1288
Parameters
- b: Pipe
Returns [Principal, string]

display

display(): string

Overrides ConstructType.display
- Defined in src/utils/idl.ts:1315
Returns string

Private encodeAnnotation

encodeAnnotation(ann: string): Buffer

- Defined in src/utils/idl.ts:1322
Parameters
- ann: string
Returns Buffer

encodeType

encodeType(typeTable: TypeTable): Buffer

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

Parameters
- typeTable: TypeTable
Returns Buffer

encodeValue

encodeValue(x: [Principal, string]): Buffer

Overrides ConstructType.encodeValue
- Defined in src/utils/idl.ts:1257
Encode the value. This needs to be public because it is used by encodeValue() from different types.

Parameters
- x: [Principal, string]
Returns Buffer

valueToString

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

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

Static argsToString

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

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

Legend

Variable
Function
Function with type parameter
Type alias
Type alias with type parameter

Class
Class with type parameter
Constructor
Property
Method

Interface
Interface with type parameter

Enumeration

Inherited method

Private method

Static method