key-value-transformer

Scans and 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" ];})

API

Table of Contents

• KeyValueUpdates
  • Parameters
• Lines
• KeyValueTransformOptions
  • Properties
• colonSeparatedKeyValuePairOptions
• equalSeparatedKeyValuePairOptions
• colonSeparatedKeyValuePairOptionsDoublingKeys
• keyValueTransformer
  • Parameters

KeyValueUpdates

Type: Function

Parameters

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

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

Lines

Type: Function

Returns Iterable<string>

KeyValueTransformOptions

Type: Object

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 from value like '=' or ':'
• keyValueLines Function to generate line(s) for a key value(s) pair
• trailingLines Lines? lines coming after all key values have been written
• headLines Lines? lines before all key values have been written

colonSeparatedKeyValuePairOptions

Type: Object

equalSeparatedKeyValuePairOptions

Type: Object

colonSeparatedKeyValuePairOptionsDoublingKeys

Type: Object

keyValueTransformer

Replaces key value pairs in a stream of lines.

Parameters

• source AsyncIterable<string> input lines
• updates KeyValueUpdates
• options KeyValueTransformOptions (optional, default colonSeparatedKeyValuePairOptions)

Returns AsyncIterable<string> lines with replaces key value pairs

install

With npm do:

npm install key-value-transformer

license

BSD-2-Clause