Package Exports
- @hinw/vdf-parser
- @hinw/vdf-parser/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hinw/vdf-parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@hinw/vdf-parser
A simple parser for Valve's KeyValue text file format (VDF) https://developer.valvesoftware.com/wiki/KeyValues. Written in JavaScript (TypeScript).
Support both returning an object OR piping readable stream to the parser streaming out key-value pairs.
Installation
Pick your favorite package manager. For example using npm:
npm install @hinw/vdf-parserInterfaces
Parse as an object
Parse a file
import { VdfParser } from '@hinw/vdf-parser';
// file content: "key" { "nested_key" "value" }"
const filePath = 'input/sample.vdf';
const parser = new VdfParser();
const result = await parser.parseFile(filePath);
// assert.assertEqual(result, { key: { nested_key: 'value' } });Parse a read stream
import stream from 'node:stream';
import { VdfParser } from '@hinw/vdf-parser';
const readStream = stream.Readable.from(`"key" { "nested_key" "value" }"`);
const parser = new VdfParser();
const result = await parser.parseStream(readStream);
// assert.assertEqual(result, { key: { nested_key: 'value' } });Parse a string
import { VdfParser } from '@hinw/vdf-parser';
const input = `"key" { "nested_key" "value" }"`;
const parser = new VdfParser();
const result = await parser.parseText(input);
// assert.assertEqual(result, { key: { nested_key: 'value' } });Stream interface related
pipe to the parser and build the object from the stream output
import fs from 'node:fs'
import { VdfParser } from '@hinw/vdf-parser';
// file content: "key" { "nested_key" "value" }"
const filePath = 'input/sample.vdf';
const parser = new VdfParser();
const fileStream = fs.createReadStream(filePath)
const parserStream = fileStream.pipe(parser)
for await (const pair of parserStream) {
// assert.assertEqual(pair, { keyParts: ['key', 'nested_key'], value: 'value' });
}Condense the pairs to an object using condensePairs or condensePairsAsync
// You can build the object from the stream using async iterator interface:
const fileStream = fs.createReadStream(filePath)
const parserStream = fileStream.pipe(parser)
const result = await parser.condensePairsAsync(parserStream)
// Or you can store the pairs somewhere, and build it afterwards with normal iterator interface:
const fileStream = fs.createReadStream(filePath)
const parserStream = fileStream.pipe(parser)
const pairs = await Array.fromAsync(parserStream)
const result = parser.condensePairs(pairs)
Options
Escape sequence
By default, the parser will handle escape sequence. To disable this behavior, you can set disableEscape to true.
import { VdfParser } from '@hinw/vdf-parser';
const input = `"\\"quoted key\\"" "value"`;
const parser = new VdfParser({ disableEscape: true });
const result = await parser.parseText(input);
// assert.assertEqual(result, { '\\"quoted key\\"': 'value' });Handling duplicated keys
By default, the parser will use the earliest seen value for the duplicated keys.
import { VdfParser } from '@hinw/vdf-parser';
const input = `"key" { "nested_key" "value" }" "key" "value"`;
const parser = new VdfParser();
const result = await parser.parseText(input);
// assert.assertEqual(result, { key: { nested_key: 'value' } });However, you can set useLatestValue to true to use the latest seen value instead.
import { VdfParser } from '@hinw/vdf-parser';
const input = `"key" { "nested_key" "value" }" "key" "value"`;
const parser = new VdfParser({ useLatestValue: true });
const result = await parser.parseText(input);
// assert.assertEqual(result, { 'key': 'value' });