Newsworthy Presidential Mistakes

    simple-vdf-mstan

    1.3.1 • Public • Published

    simple-vdf2

    Travis-CI Build Status Codecov branch Codacy Badge

    Dev Dependencies Peer Dependencies

    JavaScript Style Guide


    A Simple library for Text-based VDF (Valve Data Format) (de)serialization.

    Based on l3laze's simple-vdf2 which is based on Rossen Georgiev's simple-vdf.

    methods

    parse(string[,string])

    Parse a string containing VDF and returns an object.

    First string is the VDF in its entirety Second string is a special string that's passed to postpend to duplicate keys.

    stringify(obj[,boolean,string]) / dump(obj[,boolean,string])

    Serializes an object to a string of VDF.

    Object is the JSON to stringify. Boolean is whether or not ot make the VDF output pretty (Indendentations) String is an OPTIONAL string to strip from duplicate postpended keys

    modification in mstan variant

    Backwards compatible with l3laze's iteration of simple-vdf.

    By default, previous implementations of simple-vdf did NOT support any object that contained duplicate keys (for example, classloadoutpanel.res in TF2's HUD files contains multiple "animations" in the same object).

    In this implementation, an optional string parameter is available in parse. This is something that will be postpended to any duplicate keys. (For example, if "animation" already exists in JSON, a second animation will become "animation-KEY-2", "animation-KEY-3"...). The same key will need to be provided in stringify/dump in order to strip that key back out. (Providing a different key from a parse will have undesirable results)

    Without supplying the optional string, the old behavior will occur, in which duplicates will override each other (and the last one will be the one that results).

    Install

    npm i simple-vdf-mstan

    DownloadsWeekly Downloads

    2

    Version

    1.3.1

    License

    MIT

    Unpacked Size

    105 kB

    Total Files

    7

    Last publish

    Collaborators

    • mstan