key-value-transformer

Replaces key value pairs in a stream of lines

import { keyValueTransformer } from "key-value-transformer";

const input = getTextStream();
const output = keyValueTransformer(input, async * (key,value) => { yield [key, "newValue" ];})

Table of Contents

• KeyValueUpdates

*   [Parameters](#parameters)

• KeyValueTransformOptions

*   [Properties](#properties)

• colonSeparatedKeyValuePairOptions
• equalSeparatedKeyValuePairOptions
• colonSeparatedKeyValuePairOptionsDoublingKeys
• keyValueTransformer

*   [Parameters](#parameters-1)

KeyValueUpdates

Type: Function

Parameters

• key string current key
• value string current value
• presentKeys Set<string> the already seen keys

Returns AsyncIterator<Array<string>> updated key and value pairs

KeyValueTransformOptions

Type: Objects

Properties

• extractKeyValue Function 1st. line with key and value
• extractValueContinuation

Function additional lines holding only values

lineEnding

string used to separate lines

keyValueSeparator

string chars to separate key vrom value like '=' or ':'

keyValueLines

Function to generate line(s) for a key value(s) pair

trailingLines

Iterator<string> lines coming after all key values have been written

colonSeparatedKeyValuePairOptions

equalSeparatedKeyValuePairOptions

colonSeparatedKeyValuePairOptionsDoublingKeys

keyValueTransformer

Replaces key value pairs in a stream of lines.

Parameters

• source AsyncIterator<string>
• updates KeyValueUpdates
• options KeyValueTransformOptions (optional, default colonSeparatedKeyValuePairOptions)

Returns AsyncIterator<string> lines with replaces key value pairs

install

With npm do:

npm install key-value-transformer

BSD-2-Clause