TransformImpl

Defined in: transform/transform-impl.ts:30

Runtime implementation of a transform.

Transforms are registered in a TransformRegistry and looked up by their namespace and name during plan execution.

Example

const parseJsonImpl: TransformImpl<string, JsonValue> = {
  namespace: 'core',
  name: 'parseJson',
  execute(input: string): JsonValue {
    return JSON.parse(input)
  }
}

Type Parameters

In

In = unknown

The input type the transform accepts

Out

Out = unknown

The output type the transform produces

Properties

name

readonly name: string

Defined in: transform/transform-impl.ts:34

Transform name within namespace (must match TransformAst.name)

---

namespace

readonly namespace: string

Defined in: transform/transform-impl.ts:32

Package/module namespace (must match TransformAst.namespace)

Methods

execute()

execute(input, args?): Out | Promise<Out>

Defined in: transform/transform-impl.ts:43

Execute the transformation.

Parameters

input

In

Input value from the previous node

args?

unknown

Optional arguments from the TransformAst

Returns

Out | Promise<Out>

Transformed output (sync or async)