Class VisitTransform

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

Hierarchy (view full)

types.IDL.Visitor<types.DynamicDataArgs, MethodResult>
- VisitTransform

Constructors

constructor

new VisitTransform(): VisitTransform
Returns VisitTransform
Inherited from Visitor.constructor

Methods

visitEmpty

visitEmpty(t, data): MethodResult
Parameters
- t: types.IDL.EmptyClass
- data: types.DynamicDataArgs<unknown>
Returns MethodResult
Inherited from Visitor.visitEmpty
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:19

visitReserved

visitReserved(t, data): MethodResult
Parameters
- t: types.IDL.ReservedClass
- data: types.DynamicDataArgs<unknown>
Returns MethodResult
Inherited from Visitor.visitReserved
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:22

visitConstruct

visitConstruct<T>(t, data): MethodResult
Type Parameters
- T
Parameters
- t: types.IDL.ConstructType<T>
- data: types.DynamicDataArgs<unknown>
Returns MethodResult
Inherited from Visitor.visitConstruct
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:31

visitService

visitService(t, data): MethodResult
Parameters
- t: types.IDL.ServiceClass
- data: types.DynamicDataArgs<unknown>
Returns MethodResult
Inherited from Visitor.visitService
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:39

visitFunc

visitFunc(t, __namedParameters): NormalMethodResult
Parameters
- t: types.IDL.FuncClass
- __namedParameters: types.DynamicDataArgs<unknown>
Returns NormalMethodResult
Overrides Visitor.visitFunc
- Defined in packages/visitor/src/transform/index.ts:29

visitRec

visitRec<T>(_t, ty, data): MethodResult
Type Parameters
- T
Parameters
- _t: types.IDL.RecClass<T>
- ty: types.IDL.ConstructType<T>
- data: types.DynamicDataArgs<T>
Returns MethodResult
Overrides Visitor.visitRec
- Defined in packages/visitor/src/transform/index.ts:52

visitOpt

visitOpt<T>(_t, ty, __namedParameters): OptionalMethodResult
Type Parameters
- T
Parameters
- _t: types.IDL.OptClass<T>
- ty: types.IDL.Type<T>
- __namedParameters: types.DynamicDataArgs<null | T[]>
Returns OptionalMethodResult
Overrides Visitor.visitOpt
- Defined in packages/visitor/src/transform/index.ts:60

visitRecord

visitRecord(_t, fields, __namedParameters): RecordMethodResult
Parameters
- _t: types.IDL.RecordClass
- fields: [string, types.IDL.Type<any>][]
- __namedParameters: types.DynamicDataArgs<Record<string, unknown>>
Returns RecordMethodResult
Overrides Visitor.visitRecord
- Defined in packages/visitor/src/transform/index.ts:80

visitTuple

visitTuple<T>(_t, components, __namedParameters): DefaultMethodResult & ({
    type: "tuple";
    componentType: "normal";
    values: (NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult)[];
} | {
    type: "tuple";
    componentType: "record";
    key: NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult;
    value: NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult;
} | {
    type: "tuple";
    componentType: "title";
    value: NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult;
} | {
    type: "tuple";
    componentType: "keyValue";
    key: NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult;
    value: NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult;
})
Type Parameters
- T extends types.IDL.Type<any>[]
Parameters
- _t: types.IDL.TupleClass<T>
- components: types.IDL.Type<any>[]
- __namedParameters: types.DynamicDataArgs<unknown[]>
Returns DefaultMethodResult & ({
    type: "tuple";
    componentType: "normal";
    values: (NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult)[];
} | {
    type: "tuple";
    componentType: "record";
    key: NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult;
    value: NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult;
} | {
    type: "tuple";
    componentType: "title";
    value: NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult;
} | {
    type: "tuple";
    componentType: "keyValue";
    key: NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult;
    value: NormalMethodResult | RecordMethodResult | VariantMethodResult | (DefaultMethodResult & ({ ...; } | ... 2 more ... | { ...; })) | ... 7 more ... | UnknownMethodResult;
})
Overrides Visitor.visitTuple
- Defined in packages/visitor/src/transform/index.ts:107

visitVariant

visitVariant(_t, fields, __namedParameters): MethodResult
Parameters
- _t: types.IDL.VariantClass
- fields: [string, types.IDL.Type<any>][]
- __namedParameters: types.DynamicDataArgs<Record<string, unknown>>
Returns MethodResult
Overrides Visitor.visitVariant
- Defined in packages/visitor/src/transform/index.ts:165

visitVec

visitVec<T>(t, ty, __namedParameters): VectorMethodResult
Type Parameters
- T
Parameters
- t: types.IDL.VecClass<T>
- ty: types.IDL.Type<T>
- __namedParameters: types.DynamicDataArgs<T[]>
Returns VectorMethodResult
Overrides Visitor.visitVec
- Defined in packages/visitor/src/transform/index.ts:193

visitText

visitText(_t, __namedParameters): TextMethodResult
Parameters
- _t: types.IDL.TextClass
- __namedParameters: types.DynamicDataArgs<string>
Returns TextMethodResult
Overrides Visitor.visitText
- Defined in packages/visitor/src/transform/index.ts:248

visitNumber

visitNumber<T>(_t, __namedParameters): NumberMethodResult
Type Parameters
- T
Parameters
- _t: types.IDL.Type<T>
- __namedParameters: types.DynamicDataArgs<number | bigint>
Returns NumberMethodResult
Overrides Visitor.visitNumber
- Defined in packages/visitor/src/transform/index.ts:263

Class VisitTransform

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Returns VisitTransform

Methods

visitEmpty

Parameters

Returns MethodResult

visitReserved

Parameters

Returns MethodResult

visitConstruct

Type Parameters

Parameters

Returns MethodResult

visitService

Parameters

Returns MethodResult

visitFunc

Parameters

Returns NormalMethodResult

visitRec

Type Parameters

Parameters

Returns MethodResult

visitOpt

Type Parameters

Parameters

Returns OptionalMethodResult

visitRecord

Parameters

Returns RecordMethodResult

visitTuple

Type Parameters

Parameters

visitVariant

Parameters

Returns MethodResult

visitVec

Type Parameters

Parameters

Returns VectorMethodResult

visitText

Parameters

Returns TextMethodResult

visitNumber

Type Parameters

Parameters

Returns NumberMethodResult

visitInt

Parameters

Returns NumberMethodResult

visitNat

Parameters

Returns NumberMethodResult

visitFloat

Parameters

Returns NumberMethodResult

visitFixedInt

Parameters

Returns NumberMethodResult

visitFixedNat

Parameters

Returns NumberMethodResult

visitPrimitive

Type Parameters

Parameters

Returns MethodResult

visitNull

Parameters

Returns TextMethodResult

visitBool

Parameters

Returns BooleanMethodResult

visitPrincipal

Parameters