Class VisitReturnDetail<A>

Visit the candid file and extract the details. It returns the extracted service details.

Type Parameters

A = types.BaseActor

Hierarchy (view full)

types.IDL.Visitor<string, ReturnDetailRecord<A> | MethodReturnDetail<A> | FieldDetailWithChild | FieldDetail>
- VisitReturnDetail

Constructors

constructor

new VisitReturnDetail<A>(): VisitReturnDetail<A>
Type Parameters
- A = types.BaseActor
Returns VisitReturnDetail<A>
Inherited from Visitor.constructor

Properties

`Private` visitReturnField

visitReturnField: VisitReturn<types.BaseActor> = ...

counter

counter: number = 0

`Private` status

status: number = Status.Default

`Private` isTable

isTable: boolean = false

`Private` visitedRecursive

visitedRecursive: Record<string, true> = {}

visitInt

visitInt: (<T>(_t, label) => FieldDetail) = ...

Type declaration

- <T>(_t, label): FieldDetail
- Type Parameters
  - T
  Parameters
  - _t: types.IDL.Type<T>
  - label: string
  Returns FieldDetail

visitNat

visitNat: (<T>(_t, label) => FieldDetail) = ...

Type declaration

- <T>(_t, label): FieldDetail
- Type Parameters
  - T
  Parameters
  - _t: types.IDL.Type<T>
  - label: string
  Returns FieldDetail

visitFloat

visitFloat: (<T>(_t, label) => FieldDetail) = ...

Type declaration

- <T>(_t, label): FieldDetail
- Type Parameters
  - T
  Parameters
  - _t: types.IDL.Type<T>
  - label: string
  Returns FieldDetail

visitFixedInt

visitFixedInt: (<T>(_t, label) => FieldDetail) = ...

Type declaration

- <T>(_t, label): FieldDetail
- Type Parameters
  - T
  Parameters
  - _t: types.IDL.Type<T>
  - label: string
  Returns FieldDetail

visitFixedNat

visitFixedNat: (<T>(_t, label) => FieldDetail) = ...

Type declaration

- <T>(_t, label): FieldDetail
- Type Parameters
  - T
  Parameters
  - _t: types.IDL.Type<T>
  - label: string
  Returns FieldDetail

Methods

visitPrimitive

visitPrimitive<T>(t, data): FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>
Type Parameters
- T
Parameters
- t: types.IDL.PrimitiveType<T>
- data: string
Returns FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>
Inherited from Visitor.visitPrimitive
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:18

visitEmpty

visitEmpty(t, data): FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>
Parameters
- t: types.IDL.EmptyClass
- data: string
Returns FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>
Inherited from Visitor.visitEmpty
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:19

visitReserved

visitReserved(t, data): FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>
Parameters
- t: types.IDL.ReservedClass
- data: string
Returns FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>
Inherited from Visitor.visitReserved
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:22

visitConstruct

visitConstruct<T>(t, data): FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>
Type Parameters
- T
Parameters
- t: types.IDL.ConstructType<T>
- data: string
Returns FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>
Inherited from Visitor.visitConstruct
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:31

visitFunc

visitFunc<M>(t, functionName): MethodReturnDetail<A>
Type Parameters
- M extends string
Parameters
- t: types.IDL.FuncClass
- functionName: M
Returns MethodReturnDetail<A>
Overrides Visitor.visitFunc
- Defined in packages/visitor/src/detail/rets.ts:31

visitRecord

visitRecord(_t, _fields, label): FieldDetailWithChild
Parameters
- _t: types.IDL.RecordClass
- _fields: [string, types.IDL.Type<any>][]
- label: string
Returns FieldDetailWithChild
Overrides Visitor.visitRecord
- Defined in packages/visitor/src/detail/rets.ts:59

visitTuple

visitTuple<T>(_t, components, label): FieldDetailWithChild
Type Parameters
- T extends types.IDL.Type<any>[]
Parameters
- _t: types.IDL.TupleClass<T>
- components: types.IDL.Type<any>[]
- label: string
Returns FieldDetailWithChild
Overrides Visitor.visitTuple
- Defined in packages/visitor/src/detail/rets.ts:88

`Private` visiGenericType

visiGenericType(label): FieldDetail
Parameters
- label: string
Returns FieldDetail
- Defined in packages/visitor/src/detail/rets.ts:233

visitBool

visitBool(_t, label): FieldDetail
Parameters
- _t: types.IDL.BoolClass
- label: string
Returns FieldDetail
Overrides Visitor.visitBool
- Defined in packages/visitor/src/detail/rets.ts:247

visitType

visitType<T>(_t, label): FieldDetail
Type Parameters
- T
Parameters
- _t: types.IDL.Type<T>
- label: string
Returns FieldDetail
Overrides Visitor.visitType
- Defined in packages/visitor/src/detail/rets.ts:251

visitPrincipal

visitPrincipal(_t, label): FieldDetail
Parameters
- _t: types.IDL.PrincipalClass
- label: string
Returns FieldDetail
Overrides Visitor.visitPrincipal
- Defined in packages/visitor/src/detail/rets.ts:255

visitText

visitText(_t, label): FieldDetail
Parameters
- _t: types.IDL.TextClass
- label: string
Returns FieldDetail
Overrides Visitor.visitText
- Defined in packages/visitor/src/detail/rets.ts:259

visitNumber

visitNumber<T>(_t, label): FieldDetail
Type Parameters
- T
Parameters
- _t: types.IDL.Type<T>
- label: string
Returns FieldDetail
Overrides Visitor.visitNumber
- Defined in packages/visitor/src/detail/rets.ts:263

visitService

visitService(t): ReturnDetailRecord<A>
Parameters
- t: types.IDL.ServiceClass
Returns ReturnDetailRecord<A>
Overrides Visitor.visitService
- Defined in packages/visitor/src/detail/rets.ts:273

Class VisitReturnDetail<A>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns VisitReturnDetail<A>

Properties

Private visitReturnField

counter

Private status

Private isTable

Private visitedRecursive

visitInt

Type declaration

Type Parameters

Parameters

Returns FieldDetail

visitNat

Type declaration

Type Parameters

Parameters

Returns FieldDetail

visitFloat

Type declaration

Type Parameters

Parameters

Returns FieldDetail

visitFixedInt

Type declaration

Type Parameters

Parameters

Returns FieldDetail

visitFixedNat

Type declaration

Type Parameters

Parameters

Returns FieldDetail

Methods

visitPrimitive

Type Parameters

Parameters

Returns FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>

visitEmpty

Parameters

Returns FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>

visitReserved

Parameters

Returns FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>

visitConstruct

Type Parameters

Parameters

Returns FieldDetail | FieldDetailWithChild | ReturnDetailRecord<A> | MethodReturnDetail<A>

visitFunc

Type Parameters

Parameters

Returns MethodReturnDetail<A>

visitRecord

Parameters

Returns FieldDetailWithChild

visitTuple

Type Parameters

Parameters

Returns FieldDetailWithChild

visitVariant

Parameters

Returns FieldDetailWithChild

visitRec

Type Parameters

Parameters

Returns FieldDetailWithChild

visitOpt

Type Parameters

Parameters

Returns FieldDetailWithChild

visitVec

`Private` visitReturnField

`Private` status

`Private` isTable

`Private` visitedRecursive

`Private` visiGenericType