import PartialTransformer from 'atscm/src/lib/transform/PartialTransformer.js'

public class | source

PartialTransformer

Extends:

Transformer → PartialTransformer

Direct Subclass:

NewlinesTransformer, SplittingTransformer

Indirect Subclass:

DisplayTransformer, ScriptTransformer, XMLTransformer

A transformer that transforms only some of the files read.

Test:

Constructor Summary

Public Constructor
public	constructor(options: Object) Creates a new partial transformer with the specified options.

Member Summary

Public Members
public	filter: Stream The filter stream used.

Method Summary

Public Methods
public	applyToFilteredStream(stream: Stream, direction: TransformDirection): Stream Applies a stream transformer to the given, already filtered stream.
public	applyToStream(stream: Stream, direction: TransformDirection): Stream Applies the transformer to the given stream.
public abstract	shouldBeTransformed(file: AtviseFile) `true` if `file` should be transformed.

Private Methods
private	_transform(file: AtviseFile, enc: string, callback: function(err: ?Error, data: ?AtviseFile)) Transforms a file if PartialTransformer#shouldBeTransformed returns `true`.

Inherited Summary

From class Transformer
public static	applyTransformers(stream: Stream, transformers: Transformer[], direction: TransformDirection): Transformer Creates a stream with all transformers passed, with the given direction.
public get	transformsReferenceConfigFiles: boolean If reference config files should be handled by the transformer.
public	direction: TransformerDirection The transformer's direction
private	_options: Object The options the transformer was created with.
public	applyToStream(stream: Stream, direction: TransformDirection): Stream Applies the transformer to the given stream.
public	inspect(depth: Number, options: Object): string Prints the transformer.
public	transformFromDB(chunk: Object, enc: string, callback: function(err: ?Error, obj: ?Object)) Must be overridden by all subclasses: Transforms the given chunk when using TransformDirection.FromDB.
public	transformFromFilesystem(chunk: Object, enc: string, callback: function(err: ?Error, obj: ?Object)) Must be overridden by all subclasses: Transforms the given chunk when using TransformDirection.FromFilesystem.
public	withDirection(direction: TransformDirection): Transformer Returns the Transformer with the given direction.
private	_processError(err: Error, chunk: , callback: function(err: ?Error), args: Array<>) Decorates an error that occurred while running a transformer.
private	_transform(chunk: Object, enc: string, callback: function(err: ?Error, obj: ?Object)) Calls Transformer#transformFromDB or Transformer#transformFromFilesystem based on the transformer's direction.

Public Constructors

public constructor(options: Object) source

Creates a new partial transformer with the specified options.

Override:

Transformer#constructor

Params:

Name	Type	Attribute	Description
options	Object		The options to use. See Transformer#constructor for available options.

Test:

PartialTransformer #constructor

Public Members

public filter: Stream source

The filter stream used.

Test:

PartialTransformer #filter

Public Methods

public applyToFilteredStream(stream: Stream, direction: TransformDirection): Stream source

Applies a stream transformer to the given, already filtered stream. Override this method if you want to pipe streams directly. Returning a falsy value (false, null, undefined, ...) invokes Transformer#transformFromDB or Transformer#transformFromFilesystem instead.

Params:

Name	Type	Attribute	Description
stream	Stream		The stream to apply the transformer to.
direction	TransformDirection		The direction to use.

Return:

Stream (nullable: true)

The resulting stream.

Test:

PartialTransformer #applyToFilteredStream

public applyToStream(stream: Stream, direction: TransformDirection): Stream source

Applies the transformer to the given stream. It does so by running the following steps:

Pipe the PartialTransformer#filter stream
If PartialTransformer#applyToFilteredStream is overrridden, apply it.
Otherwise pipe Transformer#withDirection.
Restore the filter stream.

Override:

Transformer#applyToStream

Params:

Name	Type	Attribute	Description
stream	Stream		The stream to apply the transformer to.
direction	TransformDirection		The direction to use.

Return:

Stream

The resulting stream.

Test:

PartialTransformer #applyToStream

public abstract shouldBeTransformed(file: AtviseFile) source

true if file should be transformed.

Params:

Name	Type	Attribute	Description
file	AtviseFile		The file to transform or not.

Test:

PartialTransformer #shouldBeTransformed

Private Methods

private _transform(file: AtviseFile, enc: string, callback: function(err: ?Error, data: ?AtviseFile)) source

Transforms a file if PartialTransformer#shouldBeTransformed returns true.

Override:

Transformer#_transform

Params:

Name	Type	Attribute	Description
file	AtviseFile		The file to transform.
enc	string		The encoding used.
callback	function(err: ?Error, data: ?AtviseFile)		Called with the error that occured while transforming or (optionally) the transformed file.

Test:

PartialTransformer #_transform