Getting started with Kupier.JSON

Documentation:

    const kuiper = require('kuiper.json');

    //kuiper.write(path, key, value)

    kuiper.write("./text/file.json", "myNewKey", "myNewValue");

    //This will add the Key and Value to the file specified by Path.
    //If the file does not exist, it will be created.

    //kuiper.read(path, key)

    kuiper.read("./text/file.json", "myNewKey");

    //This will return "myNewValue", the Value we wrote from xero.write().
    //If no key is specified, the entire file is returned as a string.

    //kuiper.delete(path, key)

    kuiper.delete("./text/file.json", "myNewKey");

    //This will delete the Key "myNewKey" and its Value.
    //If no key is specified, the entire file is deleted.

    //kuiper.exists(path)

    kuiper.exists("./text/file.json") || data.exists("./text/file.json", 'myNewKey')

    //If the file/key exists, this function will return true.
    //Otherwise, this function will return false

    //kuiper.readDir(path)

    kuiper.readDir("./text/")

    //Returns all files in the provided directory as an Array.
    //If the path is not a directory, it will throw an error

Interims

Interims are Kuiper.JSON's way of temporarily storing JSON data without saving it to a file! Think of an "Interim" as an unsaved JSON file being edited.

    const interim = require('kuiper.json');

    //interim.write(interim, key, value)

    interim.write("myNewInterim", "myCoolKey", "myCoolValue");

    //This will add the Key and Value to the Interim.
    //If the Interim does not exist, one will be created.

    //interim.save(interim, path)

    interim.save("interim.JSON", "myNewInterim");

    //This will save the Interim to the specified path.
    //If the Interim does not exist, Kuiper.JSON will throw an error

    //interim.import(path, interim)

    interim.import("interim.JSON", "myNewInterim");

    //Reads an entire JSON file and saves it to an Interim, creating a new one if need be.
    //If a Interim name is not provided, Kuiper.JSON will throw an error.
    //If a Path is not provided, Kuiper.JSON will throw an error.

    //interim.read(interim, key)

    interim.read("myNewInterim", "myCoolKey");

    //This will return the value of the specified Key from the specified Interim.
    //If no Key is provided, the entire Interim will be returned.
    //If the Interim does not exist, Kuiper.JSON will throw an error
    //If the Key does not exist, Kuiper.JSON will return Undefined

    //interim.delete(interim, key)

    interim.delete("myNewInterim", "myCoolkey");

    //This will remove the Key from the specified Interim.
    //If the Interim does not exist, Kuiper.JSON will throw an error
    //If the Key is not specified, the entire Interim will be deleted.

    //interim.all()

    interim.all()

    //This function will return all interims currently loaded.

DISCLAIMER: The files do NOT have to have the .json extension to be treated like JSON files.