Globals

Class Piper

Piper is the piping engine. Template pipes are defined and executed here. TODO: Scope piper.

Hierarchy

Piper

Methods

Methods

Static copy

copy(pipeName: string, newPipeName: string, func: PipeCopyFunc): void

- Defined in core/Piper.ts:51
Copies an existing pipe over to a new name.

Parameters
- pipeName: string
  
  The name of the pipe to copy.
- newPipeName: string
  
  The name of the new pipe to make from the copy.
- func: PipeCopyFunc
  
  The update pipe function to build the update.
Returns void

Static deregister

deregister(pipeName: string): boolean

- Defined in core/Piper.ts:32
Remove an existing pipe.

Parameters
- pipeName: string
  
  The pipe to remove.
Returns boolean

Whether or not the uninstall was a success.

Static pipe

pipe(value: string, pipeName: string, parameters?: undefined | string): string

- Defined in core/Piper.ts:67
Pipes a string through the Aych piper.

Parameters
- value: string
- pipeName: string
- Optional parameters: undefined | string
Returns string

Static register

register(pipeName: string, func: PipeFunc): void

- Defined in core/Piper.ts:15
Register a new pipe with piper.

Parameters
- pipeName: string
- func: PipeFunc
Returns void

Static update

update(pipeName: string, func: PipeCopyFunc): void

- Defined in core/Piper.ts:41
Updates an existing pipe.

Parameters
- pipeName: string
  
  The name of the pipe to update.
- func: PipeCopyFunc
  
  The update pipe function to build the update.
Returns void

Generated using TypeDoc