Class VisitReturn<A>

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

Type Parameters

A = types.BaseActor

Hierarchy (view full)

types.IDL.Visitor<string, MethodReturn<A> | DefaultReturn | ServiceReturn<A>>
- VisitReturn

Constructors

constructor

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

Properties

`Private` inVisit

inVisit: boolean = false

Methods

visitPrimitive

visitPrimitive<T>(t, data): DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Type Parameters
- T
Parameters
- t: types.IDL.PrimitiveType<T>
- data: string
Returns DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Inherited from Visitor.visitPrimitive
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:18

visitEmpty

visitEmpty(t, data): DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Parameters
- t: types.IDL.EmptyClass
- data: string
Returns DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Inherited from Visitor.visitEmpty
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:19

visitReserved

visitReserved(t, data): DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Parameters
- t: types.IDL.ReservedClass
- data: string
Returns DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Inherited from Visitor.visitReserved
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:22

visitConstruct

visitConstruct<T>(t, data): DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Type Parameters
- T
Parameters
- t: types.IDL.ConstructType<T>
- data: string
Returns DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Inherited from Visitor.visitConstruct
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@dfinity-candid-virtual-71f7e2d478/4/.yarn/berry/cache/@dfinity-candid-npm-2.1.3-42dc934672-10c0.zip/node_modules/@dfinity/candid/lib/cjs/idl.d.ts:31

visitTuple

visitTuple<T>(_t, components, label): TupleReturn<types.IDL.Type<any>>
Type Parameters
- T extends types.IDL.Type<any>[]
Parameters
- _t: types.IDL.TupleClass<T>
- components: types.IDL.Type<any>[]
- label: string
Returns TupleReturn<types.IDL.Type<any>>
Overrides Visitor.visitTuple
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:198

visitRec

visitRec<T>(_t, ty, label): RecursiveReturn
Type Parameters
- T
Parameters
- _t: types.IDL.RecClass<T>
- ty: types.IDL.ConstructType<T>
- label: string
Returns RecursiveReturn
Overrides Visitor.visitRec
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:225

visitOpt

visitOpt<T>(_t, ty, label): OptionalReturn
Type Parameters
- T
Parameters
- _t: types.IDL.OptClass<T>
- ty: types.IDL.Type<T>
- label: string
Returns OptionalReturn
Overrides Visitor.visitOpt
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:238

visitVec

visitVec<T>(_t, ty, label): VectorReturn | ListReturn | BlobReturn
Type Parameters
- T
Parameters
- _t: types.IDL.VecClass<T>
- ty: types.IDL.Type<T>
- label: string
Returns VectorReturn | ListReturn | BlobReturn
Overrides Visitor.visitVec
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:252

visitType

visitType<T>(_t, label): DefaultReturn
Type Parameters
- T
Parameters
- _t: types.IDL.Type<T>
- label: string
Returns DefaultReturn
Overrides Visitor.visitType
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:296

visitPrincipal

visitPrincipal(_t, label): PrincipalReturn
Parameters
- _t: types.IDL.PrincipalClass
- label: string
Returns PrincipalReturn
Overrides Visitor.visitPrincipal
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:303

visitBool

visitBool(_t, label): DefaultReturn
Parameters
- _t: types.IDL.BoolClass
- label: string
Returns DefaultReturn
Overrides Visitor.visitBool
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:313

visitNull

visitNull(_t, label): DefaultReturn
Parameters
- _t: types.IDL.NullClass
- label: string
Returns DefaultReturn
Overrides Visitor.visitNull
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:320

visitText

visitText(_t, label): DefaultReturn
Parameters
- _t: types.IDL.TextClass
- label: string
Returns DefaultReturn
Overrides Visitor.visitText
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:327

visitNumber

visitNumber<T>(_t, label): NumberReturn
Type Parameters
- T
Parameters
- _t: types.IDL.Type<T>
- label: string
Returns NumberReturn
Overrides Visitor.visitNumber
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:334

visitInt

visitInt(t, label): NumberReturn
Parameters
- t: types.IDL.IntClass
- label: string
Returns NumberReturn
Overrides Visitor.visitInt
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:352

visitNat

visitNat(t, label): NumberReturn
Parameters
- t: types.IDL.NatClass
- label: string
Returns NumberReturn
Overrides Visitor.visitNat
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:356

visitFloat

visitFloat(t, label): NumberReturn
Parameters
- t: types.IDL.FloatClass
- label: string
Returns NumberReturn
Overrides Visitor.visitFloat
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:360

visitFixedInt

visitFixedInt(t, label): NumberReturn
Parameters
- t: types.IDL.FixedIntClass
- label: string
Returns NumberReturn
Overrides Visitor.visitFixedInt
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:364

visitFixedNat

visitFixedNat(t, label): NumberReturn
Parameters
- t: types.IDL.FixedNatClass
- label: string
Returns NumberReturn
Overrides Visitor.visitFixedNat
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:368

visitService

visitService(t): ServiceReturn<A>
Parameters
- t: types.IDL.ServiceClass
Returns ServiceReturn<A>
Overrides Visitor.visitService
- Defined in work/ic-reactor/ic-reactor/packages/visitor/src/field/rets/index.ts:372

Class VisitReturn<A>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns VisitReturn<A>

Properties

Private inVisit

Methods

visitPrimitive

Type Parameters

Parameters

Returns DefaultReturn | MethodReturn<A> | ServiceReturn<A>

visitEmpty

Parameters

Returns DefaultReturn | MethodReturn<A> | ServiceReturn<A>

visitReserved

Parameters

Returns DefaultReturn | MethodReturn<A> | ServiceReturn<A>

visitConstruct

Type Parameters

Parameters

Returns DefaultReturn | MethodReturn<A> | ServiceReturn<A>

visitFunc

Parameters

Returns MethodReturn<A>

visitRecord

Parameters

Returns RecordReturn<types.IDL.Type<any>> | FunctionRecordReturn<types.IDL.Type<any>>

visitVariant

Parameters

Returns VariantReturn<types.IDL.Type<any>>

visitTuple

Type Parameters

Parameters

Returns TupleReturn<types.IDL.Type<any>>

visitRec

Type Parameters

Parameters

Returns RecursiveReturn

visitOpt

Type Parameters

Parameters

Returns OptionalReturn

visitVec

Type Parameters

Parameters

Returns VectorReturn | ListReturn | BlobReturn

visitType

Type Parameters

Parameters

Returns DefaultReturn

visitPrincipal

Parameters

Returns PrincipalReturn

visitBool

Parameters

Returns DefaultReturn

visitNull

Parameters

Returns DefaultReturn

visitText

Parameters

Returns DefaultReturn

visitNumber

Type Parameters

Parameters

Returns NumberReturn

visitInt

Parameters

Returns NumberReturn

visitNat

Parameters

Returns NumberReturn

visitFloat

`Private` inVisit