Class VisitLayout<A>

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

Type Parameters

A = types.BaseActor

Hierarchy (view full)

types.IDL.Visitor<CategoryTest[] | string, ServiceLayout<A> | number | void>
- VisitLayout

Constructors

constructor

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

Properties

counter

counter: number = 0

height

height: number = 0

`Private` visitedRecursive

visitedRecursive: Record<string, true> = {}

visitInt

visitInt: (<T>(_t) => void) = ...

Type declaration

- <T>(_t): void
- Type Parameters
  - T
  Parameters
  - _t: types.IDL.Type<T>
  Returns void

visitNat

visitNat: (<T>(_t) => void) = ...

Type declaration

- <T>(_t): void
- Type Parameters
  - T
  Parameters
  - _t: types.IDL.Type<T>
  Returns void

visitFloat

visitFloat: (<T>(_t) => void) = ...

Type declaration

- <T>(_t): void
- Type Parameters
  - T
  Parameters
  - _t: types.IDL.Type<T>
  Returns void

visitFixedInt

visitFixedInt: (<T>(_t) => void) = ...

Type declaration

- <T>(_t): void
- Type Parameters
  - T
  Parameters
  - _t: types.IDL.Type<T>
  Returns void

visitFixedNat

visitFixedNat: (<T>(_t) => void) = ...

Type declaration

- <T>(_t): void
- Type Parameters
  - T
  Parameters
  - _t: types.IDL.Type<T>
  Returns void

`Private` breakpoints

breakpoints: readonly [{
    name: "xl";
    size: 6;
}, {
    name: "md";
    size: 4;
}, {
    name: "xs";
    size: 2;
}] = DEFAULT_LAYOUTS

Methods

visitPrimitive

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

visitEmpty

visitEmpty(t, data): number | void | ServiceLayout<A>
Parameters
- t: types.IDL.EmptyClass
- data: string | CategoryTest[]
Returns number | void | ServiceLayout<A>
Inherited from Visitor.visitEmpty
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:19

visitBool

visitBool(t, data): number | void | ServiceLayout<A>
Parameters
- t: types.IDL.BoolClass
- data: string | CategoryTest[]
Returns number | void | ServiceLayout<A>
Inherited from Visitor.visitBool
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:20

visitNull

visitNull(t, data): number | void | ServiceLayout<A>
Parameters
- t: types.IDL.NullClass
- data: string | CategoryTest[]
Returns number | void | ServiceLayout<A>
Inherited from Visitor.visitNull
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:21

visitReserved

visitReserved(t, data): number | void | ServiceLayout<A>
Parameters
- t: types.IDL.ReservedClass
- data: string | CategoryTest[]
Returns number | void | ServiceLayout<A>
Inherited from Visitor.visitReserved
- Defined in node_modules/@dfinity/candid/lib/cjs/idl.d.ts:22

visitConstruct

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

visitFunc

visitFunc(t): number
Parameters
- t: types.IDL.FuncClass
Returns number
Overrides Visitor.visitFunc
- Defined in packages/visitor/src/layout/index.ts:18

visitRecord

visitRecord(_t, _fields): void
Parameters
- _t: types.IDL.RecordClass
- _fields: [string, types.IDL.Type<any>][]
Returns void
Overrides Visitor.visitRecord
- Defined in packages/visitor/src/layout/index.ts:28

visitVariant

visitVariant(_t, _fields): void
Parameters
- _t: types.IDL.VariantClass
- _fields: [string, types.IDL.Type<any>][]
Returns void
Overrides Visitor.visitVariant
- Defined in packages/visitor/src/layout/index.ts:35

visitTuple

visitTuple<T>(_t, components): void
Type Parameters
- T extends types.IDL.Type<any>[]
Parameters
- _t: types.IDL.TupleClass<T>
- components: types.IDL.Type<any>[]
Returns void
Overrides Visitor.visitTuple
- Defined in packages/visitor/src/layout/index.ts:50

visitRec

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

visitOpt

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

visitVec

visitVec<T>(_t, ty, label): void
Type Parameters
- T
Parameters
- _t: types.IDL.VecClass<T>
- ty: types.IDL.Type<T>
- label: string
Returns void
Overrides Visitor.visitVec
- Defined in packages/visitor/src/layout/index.ts:80

visitType

visitType<T>(_t): void
Type Parameters
- T
Parameters
- _t: types.IDL.Type<T>
Returns void
Overrides Visitor.visitType
- Defined in packages/visitor/src/layout/index.ts:86

visitPrincipal

visitPrincipal(_t): void
Parameters
- _t: types.IDL.PrincipalClass
Returns void
Overrides Visitor.visitPrincipal
- Defined in packages/visitor/src/layout/index.ts:90

visitText

visitText(_t): void
Parameters
- _t: types.IDL.TextClass
Returns void
Overrides Visitor.visitText
- Defined in packages/visitor/src/layout/index.ts:94

visitNumber

visitNumber<T>(_t): void
Type Parameters
- T
Parameters
- _t: types.IDL.Type<T>
Returns void
Overrides Visitor.visitNumber
- Defined in packages/visitor/src/layout/index.ts:98

`Private` generateSavedY

generateSavedY(categoryTest?): {
[k: string]: T;
}
Parameters
- Optional categoryTest: string | CategoryTest[]
Returns {
[k: string]: T;
}
- [k: string]: T
- Defined in packages/visitor/src/layout/index.ts:110

`Private` generateDefaultLayout

generateDefaultLayout(categoryTest?): ServiceLayout<A>
Parameters
- Optional categoryTest: string | CategoryTest[]
Returns ServiceLayout<A>
- Defined in packages/visitor/src/layout/index.ts:127

visitService

visitService(t, categoryTest?): ServiceLayout<A>
Parameters
- t: types.IDL.ServiceClass
- Optional categoryTest: string | CategoryTest[]
Returns ServiceLayout<A>
Overrides Visitor.visitService
- Defined in packages/visitor/src/layout/index.ts:147

Class VisitLayout<A>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns VisitLayout<A>

Properties

counter

height

Private visitedRecursive

visitInt

Type declaration

Type Parameters

Parameters

Returns void

visitNat

Type declaration

Type Parameters

Parameters

Returns void

visitFloat

Type declaration

Type Parameters

Parameters

Returns void

visitFixedInt

Type declaration

Type Parameters

Parameters

Returns void

visitFixedNat

Type declaration

Type Parameters

Parameters

Returns void

Private breakpoints

Methods

visitPrimitive

Type Parameters

Parameters

Returns number | void | ServiceLayout<A>

visitEmpty

Parameters

Returns number | void | ServiceLayout<A>

visitBool

Parameters

Returns number | void | ServiceLayout<A>

visitNull

Parameters

Returns number | void | ServiceLayout<A>

visitReserved

Parameters

Returns number | void | ServiceLayout<A>

visitConstruct

Type Parameters

Parameters

Returns number | void | ServiceLayout<A>

visitFunc

Parameters

Returns number

visitRecord

Parameters

Returns void

visitVariant

Parameters

Returns void

visitTuple

Type Parameters

Parameters

Returns void

visitRec

Type Parameters

Parameters

Returns void

visitOpt

`Private` visitedRecursive

`Private` breakpoints

`Private` generateSavedY

Returns {
[k: string]: T;
}

`Private` generateDefaultLayout