pipeline

Call Signature

pipeline(s1): Planner

Defined in: packages/engine/src/lib/planner/pipeline.ts:30

Composes stages into a Planner, feeding each stage’s output to the next. The first stage takes PlanningInput, the last produces a PlannerCandidate, and every adjacent pair must agree on the type in between; a mismatch is a compile error at the offending argument.

Every stage receives the same StageContext, and runs wrapped by its StageContext.instrument: once per request, just before it runs, under the name given with named or stage-<index>. The first Err (a Deferred or an EngineError) stops the pipeline and is returned unchanged. If the request’s signal aborts while a stage is running, the next stage does not start and the pipeline returns a CancellationError.

Accepts one to nine stages.

Parameters

s1

Planner

Returns

Planner

Example

const planner = pipeline(selectVessels, arrangeLayout);

Call Signature

pipeline<A>(s1, s2): Planner

Defined in: packages/engine/src/lib/planner/pipeline.ts:31

Composes stages into a Planner, feeding each stage’s output to the next. The first stage takes PlanningInput, the last produces a PlannerCandidate, and every adjacent pair must agree on the type in between; a mismatch is a compile error at the offending argument.

Every stage receives the same StageContext, and runs wrapped by its StageContext.instrument: once per request, just before it runs, under the name given with named or stage-<index>. The first Err (a Deferred or an EngineError) stops the pipeline and is returned unchanged. If the request’s signal aborts while a stage is running, the next stage does not start and the pipeline returns a CancellationError.

Accepts one to nine stages.

Type Parameters

A

A

Parameters

s1

Stage<PlanningInput, A>

s2

Stage<A, PlannerCandidate>

Returns

Planner

Example

const planner = pipeline(selectVessels, arrangeLayout);

Call Signature

pipeline<A, B>(s1, s2, s3): Planner

Defined in: packages/engine/src/lib/planner/pipeline.ts:35

Composes stages into a Planner, feeding each stage’s output to the next. The first stage takes PlanningInput, the last produces a PlannerCandidate, and every adjacent pair must agree on the type in between; a mismatch is a compile error at the offending argument.

Every stage receives the same StageContext, and runs wrapped by its StageContext.instrument: once per request, just before it runs, under the name given with named or stage-<index>. The first Err (a Deferred or an EngineError) stops the pipeline and is returned unchanged. If the request’s signal aborts while a stage is running, the next stage does not start and the pipeline returns a CancellationError.

Accepts one to nine stages.

Type Parameters

A

A

B

B

Parameters

s1

Stage<PlanningInput, A>

s2

Stage<A, B>

s3

Stage<B, PlannerCandidate>

Returns

Planner

Example

const planner = pipeline(selectVessels, arrangeLayout);

Call Signature

pipeline<A, B, C>(s1, s2, s3, s4): Planner

Defined in: packages/engine/src/lib/planner/pipeline.ts:40

Composes stages into a Planner, feeding each stage’s output to the next. The first stage takes PlanningInput, the last produces a PlannerCandidate, and every adjacent pair must agree on the type in between; a mismatch is a compile error at the offending argument.

Every stage receives the same StageContext, and runs wrapped by its StageContext.instrument: once per request, just before it runs, under the name given with named or stage-<index>. The first Err (a Deferred or an EngineError) stops the pipeline and is returned unchanged. If the request’s signal aborts while a stage is running, the next stage does not start and the pipeline returns a CancellationError.

Accepts one to nine stages.

Type Parameters

A

A

B

B

C

C

Parameters

s1

Stage<PlanningInput, A>

s2

Stage<A, B>

s3

Stage<B, C>

s4

Stage<C, PlannerCandidate>

Returns

Planner

Example

const planner = pipeline(selectVessels, arrangeLayout);

Call Signature

pipeline<A, B, C, D>(s1, s2, s3, s4, s5): Planner

Defined in: packages/engine/src/lib/planner/pipeline.ts:46

Composes stages into a Planner, feeding each stage’s output to the next. The first stage takes PlanningInput, the last produces a PlannerCandidate, and every adjacent pair must agree on the type in between; a mismatch is a compile error at the offending argument.

Every stage receives the same StageContext, and runs wrapped by its StageContext.instrument: once per request, just before it runs, under the name given with named or stage-<index>. The first Err (a Deferred or an EngineError) stops the pipeline and is returned unchanged. If the request’s signal aborts while a stage is running, the next stage does not start and the pipeline returns a CancellationError.

Accepts one to nine stages.

Type Parameters

A

A

B

B

C

C

D

D

Parameters

s1

Stage<PlanningInput, A>

s2

Stage<A, B>

s3

Stage<B, C>

s4

Stage<C, D>

s5

Stage<D, PlannerCandidate>

Returns

Planner

Example

const planner = pipeline(selectVessels, arrangeLayout);

Call Signature

pipeline<A, B, C, D, E>(s1, s2, s3, s4, s5, s6): Planner

Defined in: packages/engine/src/lib/planner/pipeline.ts:53

Composes stages into a Planner, feeding each stage’s output to the next. The first stage takes PlanningInput, the last produces a PlannerCandidate, and every adjacent pair must agree on the type in between; a mismatch is a compile error at the offending argument.

Every stage receives the same StageContext, and runs wrapped by its StageContext.instrument: once per request, just before it runs, under the name given with named or stage-<index>. The first Err (a Deferred or an EngineError) stops the pipeline and is returned unchanged. If the request’s signal aborts while a stage is running, the next stage does not start and the pipeline returns a CancellationError.

Accepts one to nine stages.

Type Parameters

A

A

B

B

C

C

D

D

E

E

Parameters

s1

Stage<PlanningInput, A>

s2

Stage<A, B>

s3

Stage<B, C>

s4

Stage<C, D>

s5

Stage<D, E>

s6

Stage<E, PlannerCandidate>

Returns

Planner

Example

const planner = pipeline(selectVessels, arrangeLayout);

Call Signature

pipeline<A, B, C, D, E, F>(s1, s2, s3, s4, s5, s6, s7): Planner

Defined in: packages/engine/src/lib/planner/pipeline.ts:61

Composes stages into a Planner, feeding each stage’s output to the next. The first stage takes PlanningInput, the last produces a PlannerCandidate, and every adjacent pair must agree on the type in between; a mismatch is a compile error at the offending argument.

Every stage receives the same StageContext, and runs wrapped by its StageContext.instrument: once per request, just before it runs, under the name given with named or stage-<index>. The first Err (a Deferred or an EngineError) stops the pipeline and is returned unchanged. If the request’s signal aborts while a stage is running, the next stage does not start and the pipeline returns a CancellationError.

Accepts one to nine stages.

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

Parameters

s1

Stage<PlanningInput, A>

s2

Stage<A, B>

s3

Stage<B, C>

s4

Stage<C, D>

s5

Stage<D, E>

s6

Stage<E, F>

s7

Stage<F, PlannerCandidate>

Returns

Planner

Example

const planner = pipeline(selectVessels, arrangeLayout);

Call Signature

pipeline<A, B, C, D, E, F, G>(s1, s2, s3, s4, s5, s6, s7, s8): Planner

Defined in: packages/engine/src/lib/planner/pipeline.ts:70

Composes stages into a Planner, feeding each stage’s output to the next. The first stage takes PlanningInput, the last produces a PlannerCandidate, and every adjacent pair must agree on the type in between; a mismatch is a compile error at the offending argument.

Every stage receives the same StageContext, and runs wrapped by its StageContext.instrument: once per request, just before it runs, under the name given with named or stage-<index>. The first Err (a Deferred or an EngineError) stops the pipeline and is returned unchanged. If the request’s signal aborts while a stage is running, the next stage does not start and the pipeline returns a CancellationError.

Accepts one to nine stages.

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

Parameters

s1

Stage<PlanningInput, A>

s2

Stage<A, B>

s3

Stage<B, C>

s4

Stage<C, D>

s5

Stage<D, E>

s6

Stage<E, F>

s7

Stage<F, G>

s8

Stage<G, PlannerCandidate>

Returns

Planner

Example

const planner = pipeline(selectVessels, arrangeLayout);

Call Signature

pipeline<A, B, C, D, E, F, G, H>(s1, s2, s3, s4, s5, s6, s7, s8, s9): Planner

Defined in: packages/engine/src/lib/planner/pipeline.ts:80

Composes stages into a Planner, feeding each stage’s output to the next. The first stage takes PlanningInput, the last produces a PlannerCandidate, and every adjacent pair must agree on the type in between; a mismatch is a compile error at the offending argument.

Every stage receives the same StageContext, and runs wrapped by its StageContext.instrument: once per request, just before it runs, under the name given with named or stage-<index>. The first Err (a Deferred or an EngineError) stops the pipeline and is returned unchanged. If the request’s signal aborts while a stage is running, the next stage does not start and the pipeline returns a CancellationError.

Accepts one to nine stages.

Type Parameters

A

A

B

B

C

C

D

D

E

E

F

F

G

G

H

H

Parameters

s1

Stage<PlanningInput, A>

s2

Stage<A, B>

s3

Stage<B, C>

s4

Stage<C, D>

s5

Stage<D, E>

s6

Stage<E, F>

s7

Stage<F, G>

s8

Stage<G, H>

s9

Stage<H, PlannerCandidate>

Returns

Planner

Example

const planner = pipeline(selectVessels, arrangeLayout);