Class VisitArg<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, MethodArg<A> | DefaultArg | ServiceArg<A>>
- VisitArg

Constructors

constructor

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

Methods

visitPrimitive

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

visitEmpty

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

visitReserved

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

visitConstruct

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

visitFunc

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

visitRecord

visitRecord(t, _fields, label): RecordArg<types.IDL.Type<any>>
Parameters
- t: types.IDL.RecordClass
- _fields: [string, types.IDL.Type<any>][]
- label: string
Returns RecordArg<types.IDL.Type<any>>
Overrides Visitor.visitRecord
- Defined in packages/visitor/src/field/args/index.ts:98

visitVariant

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

visitTuple

visitTuple<T>(t, components, label): TupleArg<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 TupleArg<types.IDL.Type<any>>
Overrides Visitor.visitTuple
- Defined in packages/visitor/src/field/args/index.ts:164

visitRec

visitRec<T>(t, ty, label): RecursiveArg
Type Parameters
- T
Parameters
- t: types.IDL.RecClass<T>
- ty: types.IDL.ConstructType<T>
- label: string
Returns RecursiveArg
Overrides Visitor.visitRec
- Defined in packages/visitor/src/field/args/index.ts:194

visitOpt

visitOpt<T>(t, ty, label): OptionalArg
Type Parameters
- T
Parameters
- t: types.IDL.OptClass<T>
- ty: types.IDL.Type<T>
- label: string
Returns OptionalArg
Overrides Visitor.visitOpt
- Defined in packages/visitor/src/field/args/index.ts:208

visitVec

visitVec<T>(t, ty, label): VectorArg | BlobArg
Type Parameters
- T
Parameters
- t: types.IDL.VecClass<T>
- ty: types.IDL.Type<T>
- label: string
Returns VectorArg | BlobArg
Overrides Visitor.visitVec
- Defined in packages/visitor/src/field/args/index.ts:224

visitType

visitType<T>(t, label): InputArg<types.IDL.Type<T>>
Type Parameters
- T
Parameters
- t: types.IDL.Type<T>
- label: string
Returns InputArg<types.IDL.Type<T>>
Overrides Visitor.visitType
- Defined in packages/visitor/src/field/args/index.ts:240

visitPrincipal

visitPrincipal(t, label): PrincipalArg
Parameters
- t: types.IDL.PrincipalClass
- label: string
Returns PrincipalArg
Overrides Visitor.visitPrincipal
- Defined in packages/visitor/src/field/args/index.ts:250

visitBool

visitBool(t, label): InputArg<types.IDL.BoolClass>
Parameters
- t: types.IDL.BoolClass
- label: string
Returns InputArg<types.IDL.BoolClass>
Overrides Visitor.visitBool
- Defined in packages/visitor/src/field/args/index.ts:262

visitNull

visitNull(t, label): InputArg<types.IDL.NullClass>
Parameters
- t: types.IDL.NullClass
- label: string
Returns InputArg<types.IDL.NullClass>
Overrides Visitor.visitNull
- Defined in packages/visitor/src/field/args/index.ts:272

visitText

visitText(t, label): InputArg<types.IDL.TextClass>
Parameters
- t: types.IDL.TextClass
- label: string
Returns InputArg<types.IDL.TextClass>
Overrides Visitor.visitText
- Defined in packages/visitor/src/field/args/index.ts:281

visitNumber

visitNumber<T>(t, label): NumberArg
Type Parameters
- T
Parameters
- t: types.IDL.Type<T>
- label: string
Returns NumberArg
Overrides Visitor.visitNumber
- Defined in packages/visitor/src/field/args/index.ts:291

visitInt

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

visitNat

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

visitFloat

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

visitFixedInt

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

visitFixedNat

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

visitService

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