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

Constructors

constructor

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

Methods

visitPrimitive

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

visitEmpty

visitEmpty(
t: types.IDL.EmptyClass,
data: string,
): 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/esm/idl.d.ts:19

visitReserved

visitReserved(
t: types.IDL.ReservedClass,
data: string,
): 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/esm/idl.d.ts:22

visitConstruct

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

visitFunc

visitFunc(
t: types.IDL.FuncClass,
functionName: types.FunctionName<A>,
): 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:38

visitRecord

visitRecord(
    t: types.IDL.RecordClass,
    _fields: [string, types.IDL.Type<any>][],
    label: string,
): 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:97

visitVariant

visitVariant(
    t: types.IDL.VariantClass,
    fields_: [string, types.IDL.Type<any>][],
    label: string,
): 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:126

visitTuple

visitTuple<T extends types.IDL.Type<any>[]>(
    t: types.IDL.TupleClass<T>,
    components: types.IDL.Type<any>[],
    label: string,
): 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:163

visitRec

visitRec<T>(
    t: types.IDL.RecClass<T>,
    ty: types.IDL.ConstructType<T>,
    label: string,
): 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:193

visitOpt

visitOpt<T>(
    t: types.IDL.OptClass<T>,
    ty: types.IDL.Type<T>,
    label: string,
): 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:207

visitVec

visitVec<T>(
    t: types.IDL.VecClass<T>,
    ty: types.IDL.Type<T>,
    label: string,
): 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:223

visitType

visitType<T>(t: types.IDL.Type<T>, label: string): 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:239

visitPrincipal

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

visitBool

visitBool(t: types.IDL.BoolClass, label: string): 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:261

visitNull

visitNull(t: types.IDL.NullClass, label: string): 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:271

visitText

visitText(t: types.IDL.TextClass, label: string): 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:280

visitNumber

visitNumber<T>(t: types.IDL.Type<T>, label: string): 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:290

visitInt

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

visitNat

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

visitFloat

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

visitFixedInt

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

visitFixedNat

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

visitService

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