qiwi
@qiwi/masker-common
Masker common components: interfaces, executor, utils
Install
yarn add @qiwi/masker-commonUsage
Context
export interface IEnrichedContext {
value: any // value to process
_value?: any // pipe result
id: IContextId // ctx unique key
context: IEnrichedContext // ctx self ref
parentId?: IContextId // parent ctx id
registry: IMaskerRegistry // pipe registry attached to ctx
execute: IEnrichedExecutor // executor
sync: boolean // sync / async switch
mode: IExecutionMode // lagacy sync switch
opts: IMaskerOpts // current pipe options
pipe?: IMaskerPipeNormalized // current pipe ref
pipeline: IMaskerPipelineNormalized // actual pipeline
originPipeline: IMaskerPipelineNormalized // origin pipeline
[key: string]: any
}createPipe()
Creates a pipe entity. Several pipes are combined into a pipeline to be processed by executor.
import {createPipe} from '@qiwi/masker-common'
const pipe = createPipe('foo', () => ({value: 'syncfoo'}), async () => ({value: 'asyncfoo'}))
pipe.name // 'foo'
pipe.sync({}) // {value: 'syncfoo'}
await pipe({}) // {value: 'asyncfoo'}getPipe()
Get pipe from registry.
import {getPipe, crearePipe as cp} from '@qiwi/masker-common'
const pipe = cp('foo', () => ({value: 'foo'}))
const registry = new Map()
registry.set('foo', pipe)
getPipe('foo', registry) // pipeexecute()
The pipeline executor. Transforms the target value (ctx) via the handlers queue. Provides both sync and async modes.
import {createPipe as cp, execute} from '@qiwi/masker-common'
const pipe1 = cp('pipe1', () => ({value: 'pipe1'}))
const pipe2 = cp('pipe2', ({value}) => ({value: value + 'pipe2'}))
const pipeline = [pipe1, pipe2]
const value = 'foobar'
// async
await execute({pipeline, value}) // {value: 'pipe1pipe2'}
// sync
execute({pipeline, value, sync: true}) // {value: 'pipe1pipe2'}
execute.sync({pipeline, value}) // {value: 'pipe1pipe2'}