VDF is a module to convert Valve's KeyValue format to JSON and back using Typescript.

Heavily inspired by simple-vdf

(< v2.0.0 can be used as a drop-in replacement)

Differences

Installation

You can install VDF through the command line by using the following command:

yarn add @node-steam/vdf

Usage:

import*asVDFfrom'@node-steam/vdf';// orimport{parse,stringify,}from'@node-steam/vdf';

Documentation:

Generated Documentation

VDF.parse(text: string)

Parse a VDF string into a JSON object

conststring=`"string" "string""false" "false""true" "true""number" "1234""float" "12.34""null" "null""undefined" "undefined""nested"{ "string" "string" "deep" { "string" "string" }}`;constobject=VDF.parse(string);// orconstobject=parse(string);>{string: 'string',false: false,true: true,number: 1234,float: 12.34,null: null,undefined: undefined,nested: {string: 'string',deep: {string: 'string',},},};

VDF.stringify(object: object)

Parse a JSON object into a VDF string

constobject={string: 'string',false: false,true: true,number: 1234,float: 12.34,null: null,undefined: undefined,nested: {string: 'string',deep: {string: 'string',},},};conststring=VDF.stringify(object);// orconststring=stringify(object);>`"string" "string""false" "false""true" "true""number" "1234""float" "12.34""null" "null""undefined" "undefined""nested"{ "string" "string" "deep" { "string" "string" }}`;

Differences from simple-vdf

• Correct parsing of booleans, numbers, null and undefined (>= v2.0.0)
• ES6 // Typescript syntax
• Typescript definitions
• Modern ES6 tests

Contributors

• Silas Rech aka. lenovouser

Contributing:

Interested in contributing to VDF? Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

Help:

Installing dependencies:

yarn

Compile:

yarn compile

Test:

yarn test

Generate Docs:

yarn docs

Tests:

This module is thoroughly tested with ava

License:

Code licensed under MIT, documentation under CC BY 3.0.