import {Pipeline} from 'datamatic/src/Pipeline/Pipeline.js'

public class | source

Pipeline

Pipeline Class

Static Method Summary

Static Public Methods
public static	getExecs(_pvs: ...):

Constructor Summary

Public Constructor
public	constructor(pipesOrVOsOrSchemas: *)

Member Summary

Public Members
public get	errors: * \| null: * Returns validation errors
public get	schema: *[]: undefined[] Returns arr
public get	schemas: object: undefined[] Returns JSON-SCHEMA for `pipeline` output
public get	writable: boolean: * Returns write status of `pipeline`

Method Summary

Public Methods
public	clone(): Pipeline Creates clone of current `pipeline` segment
public	close(): Pipeline Terminates input on `pipeline` segment.
public	link(target: , callbacks: ): Pipeline links pipeline segment to direct output to target pipeline
public	merge(pipeOrPipes: , pipeOrSchema: ): Pipeline Merges multiple pipes into single output
public	pipe(pipesOrSchemas: *): Pipeline Creates new `pipeline` segment
public	async promise(data: *): Promise<Pipeline> Convenience Method for Promise based flows.
public	sample(nth: *): Pipeline Returns product of Nth occurrence of `pipeline` execution
public	split(schemasOrPipes: ): Creates array of new `pipeline` segments that run in parallel
public	subscribe(handler: *): Observable Subscribes to `pipeline` output notifications
public	tap(): Object \| Array Provides current state of `pipeline` output.
public	throttle(rate: *): Pipeline Informs `Pipeline` to rate limit notifications based on time interval
public	toJSON(): Object \| Array Provides current state of `pipeline` output.
public	toString(): String Overrides Object's toString method
public	unlink(target: *): Pipeline Unlink `pipeline` segment from target `pipeline`
public	unthrottle(discardCacheQueue: *) Removes rate limiting from `Pipeline` and optionally deletes unprocessed cache items
public	write(data: *): Pipeline Writes data to pipeline segment
public	yield(data: *): generator Iterates pipeline callbacks via generator function

Static Public Methods

public static getExecs(_pvs: ...): source

Params:

Name	Type	Attribute	Description
_pvs	...*

Return:

Public Constructors

public constructor(pipesOrVOsOrSchemas: *) source

Params:

Name	Type	Attribute	Description
pipesOrVOsOrSchemas	*

Public Members

public get errors: * | null: * source

Returns validation errors

Return:

* | null

public get schema: *[]: undefined[] source

Returns arr

Return:

*[]

public get schemas: object: undefined[] source

Returns JSON-SCHEMA for pipeline output

Return:

object

public get writable: boolean: * source

Returns write status of pipeline

Return:

boolean

Public Methods

public clone(): Pipeline source

Creates clone of current pipeline segment

Return:

Pipeline

public close(): Pipeline source

Terminates input on pipeline segment. This is irrevocable

Return:

Pipeline

public link(target: , callbacks: ): Pipeline source

links pipeline segment to direct output to target pipeline

Params:

Name	Type	Attribute	Description
target	*
callbacks	*		function[]

Return:

Pipeline

public merge(pipeOrPipes: , pipeOrSchema: ): Pipeline source

Merges multiple pipes into single output

Params:

Name	Type	Attribute	Description
pipeOrPipes	*
pipeOrSchema	*

Return:

Pipeline

public pipe(pipesOrSchemas: *): Pipeline source

Creates new pipeline segment

Params:

Name	Type	Attribute	Description
pipesOrSchemas	*

Return:

Pipeline

public async promise(data: *): Promise<Pipeline> source

Convenience Method for Promise based flows. Writes data to pipeline and wraps observer in Promise

Params:

Name	Type	Attribute	Description
data	*

Return:

Promise<Pipeline>

public sample(nth: *): Pipeline source

Returns product of Nth occurrence of pipeline execution

Params:

Name	Type	Attribute	Description
nth	*

Return:

Pipeline

public split(schemasOrPipes: ): source

Creates array of new pipeline segments that run in parallel

Params:

Name	Type	Attribute	Description
schemasOrPipes	*

Return:

Subscribes to pipeline output notifications

Params:

Name	Type	Attribute	Description
handler	*

Return:

Observable

public tap(): Object | Array source

Provides current state of pipeline output. alias for toJSON

Return:

Object | Array

public throttle(rate: *): Pipeline source

Informs Pipeline to rate limit notifications based on time interval

Params:

Name	Type	Attribute	Description
rate	*

Return:

Pipeline

public toJSON(): Object | Array source

Provides current state of pipeline output.

Return:

Object | Array

public toString(): String source

Overrides Object's toString method

Return:

String

public unlink(target: *): Pipeline source

Unlink pipeline segment from target pipeline

Params:

Name	Type	Attribute	Description
target	*

Return:

Pipeline

public unthrottle(discardCacheQueue: *) source

Removes rate limiting from Pipeline and optionally deletes unprocessed cache items

Params:

Name	Type	Attribute	Description
discardCacheQueue	*

public write(data: *): Pipeline source

Writes data to pipeline segment

Params:

Name	Type	Attribute	Description
data	*

Return:

Pipeline

public yield(data: *): generator source

Iterates pipeline callbacks via generator function

Params:

Name	Type	Attribute	Description
data	*

Return:

generator

Pipeline

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Static Public Methods

public static getExecs(_pvs: ...*): * source

Params:

Return:

Public Constructors

public constructor(pipesOrVOsOrSchemas: *) source

Params:

Public Members

public get errors: * | null: * source

Return:

public get schema: *[]: undefined[] source

Return:

public get schemas: object: undefined[] source

Return:

public get writable: boolean: * source

Return:

Public Methods

public clone(): Pipeline source

Return:

public close(): Pipeline source

Return:

public link(target: *, callbacks: *): Pipeline source

Params:

Return:

public merge(pipeOrPipes: *, pipeOrSchema: *): Pipeline source

Params:

Return:

public pipe(pipesOrSchemas: *): Pipeline source

Params:

Return:

public async promise(data: *): Promise<Pipeline> source

Params:

Return:

public sample(nth: *): Pipeline source

Params:

Return:

public split(schemasOrPipes: *): * source

Params:

Return:

public subscribe(handler: *): Observable source

Params:

Return:

public tap(): Object | Array source

Return:

public throttle(rate: *): Pipeline source

Params:

Return:

public toJSON(): Object | Array source

Return:

public toString(): String source

Return:

public unlink(target: *): Pipeline source

Params:

Return:

public unthrottle(discardCacheQueue: *) source

Params:

public write(data: *): Pipeline source

Params:

Return:

public yield(data: *): generator source

Params:

Return:

public static getExecs(_pvs: ...): source

public link(target: , callbacks: ): Pipeline source

public merge(pipeOrPipes: , pipeOrSchema: ): Pipeline source

public split(schemasOrPipes: ): source