This version is out of date, covering development from v5.0.0 to v5.12.2. It is maintained here only for inbound reference links from elsewhere.

Jump to the current version of aTbRef.

Tinderbox Icon

find(query)


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Altered: 

 Function   [other Function type actions]

 Query   [operators of similar scope]

 Set & List creation   [other Set & List creation operators]

 5.6.0

 


find(query)

The find() operator returns list-type data of the $Path of all items matching query.

Conceptually find() is intended for where no item or group designator exists for use inline in action code. In most cases an agent is the likely and better alternative, noting that agents can also use the results of other agents. find() can also be thought of as a short way of writing:

collect_if(all, expression, $Path) 

where the expression is query.

The find() operator does not de-dupe results in the way an agent does. As find() collects $Path data, aliases both inside and outside agents may also match the query. Adding !$IsAlias as a query term will scrub any aliases from matching a search. But, if getting unexpected results via find consider whether it is because some de-duping was assumed and be prepared to sharpen the query terms accordingly.


Possible relevant notes (via "Similar Notes" feature):


A Tinderbox Reference File : Actions & Rules : Operators : Action Operator Scope : Query-based operators : find(query)