immutable-kv

A js module for Valve KV format. Support #base feature.

Install

1npm install immutable-kv

Import

1import KV from 'immutable-kv';

KV Parser

parse

Use parse function to convert string to KV instance:

1const kv = KV.parse(`
2"root" {
3	"aaa"	"bbb"
4	"ccc"	"ddd"
5}
6`);
7
8kv.key; // 'root'
9kv.isList; // true
10kv.get(['aaa']); // 'bbb'
11kv.getKV(['ccc']).key; // 'ccc'
12kv.getKV(['ccc']).value; // 'ddd'
13kv.getKV(['ccc']).isList; // false

update

Call setValue to get new KV instance. The same as setKey and setComment:

1const kv = KV.parse('"aaa" "bbb"');
2const newKv = kv.setValue('ccc');
3
4kv.value; // 'bbb'
5newKv.value; // 'ccc'

KV File

load

Call load to load kv data from file:

1const kv = KV.load('/tmp/kv.txt');

Or you can set customize encoding:

1const kv = KV.load('/tmp/kv.txt', 'utf8');

#base support

1const kvFileInfo = KV.baseLoad('/tmp/kv.txt');
2kvFileInfo.kv; // KV instance
3kvFileInfo.path; // Absolute path
4kvFileInfo.baseList; // List contains base refer KVFileInfo
5kvFileInfo.baseList[0].kv; // Base KV instance
6kvFileInfo.baseList[0].relativePath; // Path related to parent KV file

update kv

1const newKvFileInfo = kvFileInfo.setKV(newKV);

update base kv

setBase(origin: index | KV | KVFileInfo, target: KV | KVFileInfo)

1const newKvFileInfo = kvFileInfo.setBase(origin, target);