Class: ItemFnSource

Defined in: packages/core/src/plan/operators/item/item-source.ts:50

A leaf operator that produces items by invoking a generator function.

Implements

• PlanOperator

Constructors

Constructor

new ItemFnSource(lang, args, impl, name?): ItemFnSource

Defined in: packages/core/src/plan/operators/item/item-source.ts:57

Parameters

Parameter	Type	Description
lang	Lowercase<string>	PlanOperator.lang
args	(Calculation | ASTIdentifier)[]	Arguments passed to impl; identifiers are resolved at runtime.
impl	(...args) => Iterable<unknown>	Generator function that yields items when called with the evaluated arguments.
name?	ASTIdentifier | Aliased<ASTIdentifier>	This should be aliased only while building the plan. It should be replaced with Projection before the actual execution.

Returns

ItemFnSource

Properties

args

args: (Calculation | ASTIdentifier)[]

Defined in: packages/core/src/plan/operators/item/item-source.ts:61

Arguments passed to impl; identifiers are resolved at runtime.

---

impl

impl: (...args) => Iterable<unknown>

Defined in: packages/core/src/plan/operators/item/item-source.ts:63

Generator function that yields items when called with the evaluated arguments.

Parameters

Parameter	Type
...args	any[]

Returns

Iterable<unknown>

---

lang

lang: Lowercase<string>

Defined in: packages/core/src/plan/operators/item/item-source.ts:59

PlanOperator.lang

Implementation of

PlanOperator.lang

---

name?

optional name?: ASTIdentifier | Aliased<ASTIdentifier>

Defined in: packages/core/src/plan/operators/item/item-source.ts:65

Optional name alias; see ItemSource.name.

---

parent

parent: PlanOperator

Defined in: packages/core/src/plan/operators/item/item-source.ts:52

PlanOperator.parent

Implementation of

PlanOperator.parent

Methods

accept()

accept<Ret, Arg>(visitors, arg?): Ret

Defined in: packages/core/src/plan/operators/item/item-source.ts:71

PlanOperator.accept

Type Parameters

Type Parameter
Ret
Arg

Parameters

Parameter	Type
visitors	Record<string, PlanVisitor<Ret, Arg>>
arg?	Arg

Returns

Ret

Implementation of

PlanOperator.accept

---

clone()

clone(): ItemFnSource

Defined in: packages/core/src/plan/operators/item/item-source.ts:88

PlanOperator.clone

Returns

ItemFnSource

Implementation of

PlanOperator.clone

---

getChildren()

getChildren(): PlanOperator[]

Defined in: packages/core/src/plan/operators/item/item-source.ts:84

PlanOperator.getChildren

Returns

PlanOperator[]

Implementation of

PlanOperator.getChildren

---

getDependencies()

getDependencies(): IdSet

Defined in: packages/core/src/plan/operators/item/item-source.ts:97

PlanOperator.getDependencies

Returns

IdSet

Implementation of

PlanOperator.getDependencies

---

replaceChild()

replaceChild(current, replacement): void

Defined in: packages/core/src/plan/operators/item/item-source.ts:78

PlanOperator.replaceChild

Parameters

Parameter	Type
current	PlanOperator
replacement	PlanOperator

Returns

void

Implementation of

PlanOperator.replaceChild