@datr.tech/marble-transformer-core
Version:
Marble transformer core
26 lines (25 loc) • 928 B
TypeScript
/**
* @module core/transformers
*/
import { ITransformer } from '../../interfaces/core/transformers';
/**
* @name Transformer
*
* @description The transformer accepts an array of 'handlers',
* each of which, ultimately, would be called from the
* inner 'transform' function.
*
* @param {ITransformerInput} params
* @param {IHandler[]} params.handlers REQUIRED An array of 'handler' functions.
* @returns {ITransformerOutput} An object containing a 'transform' function.
*
* @see {@link module:interfaces/core/transformers/ITransformer}
* @see {@link module:test/unit/core/transformers}
*
* @author Datr.Tech Admin <admin@datr.tech>
* @version 0.3.1
*
* @example const transform = transformer({ handlers });
* const destination = transform({ source });
*/
export declare const transformer: ITransformer;