@gotoeasy/btf

    1.3.2 • Public • Published

    @gotoeasy/btf

    A JavaScript Block-Text-File Parser

    NPM version License

    Install

    npm i @gotoeasy/btf
    

    API

    • BlockTextFile.getText(blockName) - get text of blockName from the first Document
    • BlockTextFile.getMap(blockName) - get key-value map of blockName from the first Document
    • BlockTextFile.getDocument() - get the first Document
    • BlockTextFile.getDocuments() - get the Document array
    • Document.getText(blockName) - get text of blockName from the Document
    • Document.getMap(blockName) - get key-value map of blockName from the Document
    sample.btf
    [key1]
    value1
    ---------
    
    [key2]
    value2
    
    [key-value]
    k1 : v1
    k2 = v2
    
    =========
    [name1]
    111
    [name2]
    222
    []
    333
    [\]
    \
    [\]]
    ]
    [\]\]
    \---------
    [\][\]]
    \=========
    // parser sample.btf
    const BlockTextFile = require('@gotoeasy/btf');
    
    let btf = new BlockTextFile('sample.btf');
    
    console.info(btf.getText('key1') == 'value1'); // true
    console.info(btf.getText('key2') == 'value2\n'); // true
    
    let map = btf.getMap('key-value');
    console.info(map.get('k1') == 'v1'); // true
    console.info(map.get('k2') == 'v2'); // true
    
    let docs = btf.getDocuments(); // array
    console.info(docs.length == 2); // true
    let doc1 = docs[0];
    console.info(doc1.getText('key1') == 'value1'); // true
    console.info(doc1.getText('key2') == 'value2\n'); // true
    let doc2 = docs[1];
    console.info(doc2.getText('name1') == '111'); // true
    console.info(doc2.getText('name2') == '222'); // true
    console.info(doc2.getText('') == '333'); // true
    console.info(doc2.getText('\\') == '\\'); // true
    console.info(doc2.getText(']') == ']'); // true
    console.info(doc2.getText(']\\') == '---------'); // true
    console.info(doc2.getText('][]') == '========='); // true


    Links

    Install

    npm i @gotoeasy/btf

    DownloadsWeekly Downloads

    14

    Version

    1.3.2

    License

    MIT

    Unpacked Size

    25.2 kB

    Total Files

    9

    Last publish

    Collaborators

    • rpose