Logo ProcessKit API Reference

Pipeline Module

Pipe-friendly functions over `Pipeline`, mirroring the instance methods.

Functions and values

Function or value Description

Pipeline.cancelOn cancellationToken pipeline

Full Usage: Pipeline.cancelOn cancellationToken pipeline

Parameters:
Returns: Pipeline

Also cancel the whole pipeline when `cancellationToken` fires.

cancellationToken : CancellationToken
pipeline : Pipeline
Returns: Pipeline

Pipeline.create first second

Full Usage: Pipeline.create first second

Parameters:
Returns: Pipeline

Begin a pipeline from `first` feeding into `second`.

first : Command
second : Command
Returns: Pipeline

Pipeline.pipe next pipeline

Full Usage: Pipeline.pipe next pipeline

Parameters:
Returns: Pipeline

Append another stage to the pipeline.

next : Command
pipeline : Pipeline
Returns: Pipeline

Pipeline.timeout duration pipeline

Full Usage: Pipeline.timeout duration pipeline

Parameters:
Returns: Pipeline

Kill the whole pipeline after `duration`.

duration : TimeSpan
pipeline : Pipeline
Returns: Pipeline

Type something to start searching.