module:nmodule/export/rc/TransformOperation

module:nmodule/export/rc/TransformOperation

API Status: Development

A TransformOperation encapsulates the lifecycle of transforming an object
into data, and sending that data to a destination.

Constructor

new (require("nmodule/export/rc/TransformOperation"))(transformer, object)

Source:
Parameters:
Name Type Description
transformer module:nmodule/export/rc/Transformer

the transformer that will perform the transform operation

object *

the object to be transformed

Methods

doTransform(cx) → {Promise}

Source:
Parameters:
Name Type Description
cx object

transform context. This will be passed to the transform() method.

Returns:
Type
Promise

getDisplayName() → {String}

Source:
Returns:

the display name to be shown to the user to allow him or her to choose to perform this transform operation

Type
String

getTransformedObject() → {*}

Source:
Returns:

the object to be transformed

Type
*

getTransformer() → {module:nmodule/export/rc/Transformer}

Source:
Returns:

the transformer that will perform the transform operation

Type
module:nmodule/export/rc/Transformer