Class VisitReturn<A>

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

Type Parameters

A = types.BaseActor

Hierarchy (View Summary)

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

Constructors

constructor

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

Methods

visitPrimitive

visitPrimitive<T>(
t: types.IDL.PrimitiveType<T>,
data: string,
): 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 node_modules/@dfinity/candid/lib/esm/idl.d.ts:18

visitEmpty

visitEmpty(
t: types.IDL.EmptyClass,
data: string,
): DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Parameters
- t: types.IDL.EmptyClass
- data: string
Returns DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Inherited from Visitor.visitEmpty
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:19

visitReserved

visitReserved(
t: types.IDL.ReservedClass,
data: string,
): DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Parameters
- t: types.IDL.ReservedClass
- data: string
Returns DefaultReturn | MethodReturn<A> | ServiceReturn<A>
Inherited from Visitor.visitReserved
- Defined in node_modules/@dfinity/candid/lib/esm/idl.d.ts:22

visitConstruct

visitConstruct<T>(
t: types.IDL.ConstructType<T>,
data: string,
): 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 node_modules/@dfinity/candid/lib/esm/idl.d.ts:31

visitFunc

visitFunc(
t: types.IDL.FuncClass,
functionName: types.FunctionName<A>,
): MethodReturn<A>
Parameters
- t: types.IDL.FuncClass
- functionName: types.FunctionName<A>
Returns MethodReturn<A>
Overrides Visitor.visitFunc
- Defined in packages/visitor/src/field/rets/index.ts:44

visitRecord

visitRecord(
    _t: types.IDL.RecordClass,
    _fields: [string, types.IDL.Type<any>][],
    label: string,
):
    | RecordReturn<types.IDL.Type<any>>
    | FunctionRecordReturn<types.IDL.Type<any>>
Parameters
- _t: types.IDL.RecordClass
- _fields: [string, types.IDL.Type<any>][]
- label: string
Returns RecordReturn<types.IDL.Type<any>> | FunctionRecordReturn<types.IDL.Type<any>>
Overrides Visitor.visitRecord
- Defined in packages/visitor/src/field/rets/index.ts:106

visitVariant

visitVariant(
    _t: types.IDL.VariantClass,
    fields_: [string, types.IDL.Type<any>][],
    label: string,
): VariantReturn<types.IDL.Type<any>>
Parameters
- _t: types.IDL.VariantClass
- fields_: [string, types.IDL.Type<any>][]
- label: string
Returns VariantReturn<types.IDL.Type<any>>
Overrides Visitor.visitVariant
- Defined in packages/visitor/src/field/rets/index.ts:169

visitTuple

visitTuple<T extends types.IDL.Type<any>[]>(
    _t: types.IDL.TupleClass<T>,
    components: types.IDL.Type<any>[],
    label: string,
): 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 packages/visitor/src/field/rets/index.ts:198

visitRec

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

visitOpt

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

visitVec

visitVec<T>(
    _t: types.IDL.VecClass<T>,
    ty: types.IDL.Type<T>,
    label: string,
): 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 packages/visitor/src/field/rets/index.ts:252

visitType

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

visitNumber

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

visitInt

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

visitNat

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

visitFloat

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

visitFixedInt

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

visitFixedNat

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

visitService

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

Class VisitReturn<A>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Returns VisitReturn<A>

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

Parameters

Returns NumberReturn

visitFixedInt