Class selector<JpT, ChU>

Selects join points according to their type and filter rules.

Param: $baseJp

starting join point for the search.

Param: inclusive

if true, $baseJp is included in the search.

Type Parameters

JpT extends typeof LaraJoinPoint = typeof LaraJoinPoint
ChU extends typeof LaraJoinPoint = JpT

Index

Constructors

constructor

Methods

[iterator] chain children first get getFirst scope search convertStringFilterToWrapperFilter

Constructors

constructor

new selector<JpT, ChU>($baseJp?, inclusive?): selector<JpT, ChU>
Type Parameters
- JpT extends typeof LaraJoinPoint = typeof LaraJoinPoint
- ChU extends typeof LaraJoinPoint = JpT
Parameters
- Optional$baseJp: LaraJoinPoint
- inclusive: boolean = false
Returns selector<JpT, ChU>
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:131

Methods

[iterator]

[iterator](): Generator<InstanceType<JpT>, void, unknown>
Generator function, allows Selector to be used in for..of statements.

Returns join points iteratively, as if .get() was called.

Returns Generator<InstanceType<JpT>, void, unknown>
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:246

chain

chain(): SelectorChainAttributes<ChU>[]
Returns SelectorChainAttributes<ChU>[]
An array of objects where each object maps the name of the join point to the corresponding join point that was searched, as well as creating mappings of the format <joinpoint_name>_<repetition>. For instance, if the search chain has the same name multiple times (e.g., search("loop").search("loop")), the chain object will have an attribute "loop" mapped to the last loop of the chain, an attribute "loop_0" mapped to the first loop of the chain and an attribute "loop_1" mapped to the second loop of the chain.
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:540

children

children<T>(type?, filter?): selector<T, ChU | T>
Search in the children of the previously selected nodes.
Type Parameters
- T extends typeof LaraJoinPoint
Parameters
- Optionaltype: T
  type of the join point to search.
- Optionalfilter: Filter_WrapperVariant<T>
  filter rules for the search.
Returns selector<T, ChU | T>
The results of the search.
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:337
children(name?, filter?): selector<typeof LaraJoinPoint, typeof LaraJoinPoint>
Search in the children of the previously selected nodes.
Parameters
- Optionalname: string
  type of the join point to search.
- Optionalfilter: Filter_StringVariant
  filter rules for the search.
Returns selector<typeof LaraJoinPoint, typeof LaraJoinPoint>
The results of the search.

Deprecated
Use the new children function variant that accepts a wrapper class.
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:351

first

first(): undefined | InstanceType<JpT>
Returns undefined | InstanceType<JpT>
the first selected node
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:574

get

get(): InstanceType<JpT>[]
Returns InstanceType<JpT>[]
an array with the join points of the last chain (e.g., search("function").search("call").get() returns an array of $call join points).
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:520

getFirst

getFirst(): undefined | InstanceType<JpT>
Same as .first()

Returns undefined | InstanceType<JpT>
The first selected node
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:561

scope

scope<T>(type?, filter?): selector<T, ChU | T>
If previously select nodes have the concept of scope (e.g. if, loop), search the direct children of that scope.
Type Parameters
- T extends typeof LaraJoinPoint
Parameters
- Optionaltype: T
  type of the join point to search.
- Optionalfilter: Filter_WrapperVariant<T>
  filter rules for the search.
Returns selector<T, ChU | T>
The results of the search.
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:390
scope(name?, filter?): selector<typeof LaraJoinPoint, typeof LaraJoinPoint>
If previously select nodes have the concept of scope (e.g. if, loop), search the direct children of that scope.
Parameters
- Optionalname: string
  type of the join point to search.
- Optionalfilter: Filter_StringVariant
  filter rules for the search.
Returns selector<typeof LaraJoinPoint, typeof LaraJoinPoint>
The results of the search.

Deprecated
Use the new scope function variant that accepts a wrapper class.
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:404

search

search<T>(type?, filter?, traversal?): selector<T, ChU | T>
Type Parameters
- T extends typeof LaraJoinPoint
Parameters
- Optionaltype: T
  type of the join point to search.
- Optionalfilter: Filter_WrapperVariant<T>
  filter rules for the search.
- Optionaltraversal: TraversalType
  AST traversal type, according to TraversalType
Returns selector<T, ChU | T>
The results of the search.
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:266
search(type?, filter?, traversal?): selector<typeof LaraJoinPoint, typeof LaraJoinPoint>
Parameters
- Optionaltype: string
- Optionalfilter: Filter_StringVariant
  filter rules for the search.
- Optionaltraversal: TraversalType
  AST traversal type, according to TraversalType
Returns selector<typeof LaraJoinPoint, typeof LaraJoinPoint>
The results of the search.

Deprecated
Use the new search function variant that accepts a wrapper class.
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:280

`Static`convertStringFilterToWrapperFilter

convertStringFilterToWrapperFilter(joinPointType?, filter?): JpFilterFunction<typeof LaraJoinPoint>
Parameters
- joinPointType: string = ""
- Optionalfilter: Filter_StringVariant
Returns JpFilterFunction<typeof LaraJoinPoint>
- Defined in lara-framework/Lara-JS/src-api/weaver/Selector.ts:198

Class selector<JpT, ChU>

Param: $baseJp

Param: inclusive

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns selector<JpT, ChU>

Methods

[iterator]

Returns Generator<InstanceType<JpT>, void, unknown>

chain

Returns SelectorChainAttributes<ChU>[]

children

Type Parameters

Parameters

Returns selector<T, ChU | T>

Parameters

Returns selector<typeof LaraJoinPoint, typeof LaraJoinPoint>

Deprecated

first

Returns undefined | InstanceType<JpT>

get

Returns InstanceType<JpT>[]

getFirst

Returns undefined | InstanceType<JpT>

scope

Type Parameters

Parameters

Returns selector<T, ChU | T>

Parameters

Returns selector<typeof LaraJoinPoint, typeof LaraJoinPoint>

Deprecated

search

Type Parameters

Parameters

Returns selector<T, ChU | T>

Parameters

Returns selector<typeof LaraJoinPoint, typeof LaraJoinPoint>

Deprecated

StaticconvertStringFilterToWrapperFilter

Parameters

Returns JpFilterFunction<typeof LaraJoinPoint>

Settings

On This Page

`Static`convertStringFilterToWrapperFilter