Getting started

  1. Download the core jIO, the storages you need and the dependencies required for them.

  2. Add the scripts to your HTML page in the following order:

    <!-- jio core + dependencies -->
<script src="rsvp.js"></script>
<script src="jio.js"></script>

<script ...>

  3. jIO connects to a number of storages and allows adding handlers (or functions) to specific storages. You can use both handlers and available storages to build a storage tree across which all documents will be maintained and managed by jIO.

    // create your jio instance
var my_jio = jIO.createJIO(storage_description);

    You have to provide a storage_description object, providing location and credentials.

    Its format depends on the type of storage, see List of Available Storages.

  4. The jIO API provides ten main methods to manage documents across the storage(s) specified in your jIO storage tree.

    For details on the document and attachment objects, see What is a document?

    Method Example
    .post()
    my_jio.post(document, [options]);
    Creates a new document
    .put()
    my_jio.put(document, [options]);
    Creates/Updates a document
    .putAttachment()
    my_jio.putAttachement(attachment, [options]);`
    Updates/Adds an attachment to a document
    .get()
    my_jio.get(document, [options]);
    Reads a document
    .getAttachment()
    my_jio.getAttachment(attachment, [options]);
    Reads a document attachment
    .remove()
    my_jio.remove(document, [options]);
    Deletes a document and its attachments
    .removeAttachment()
    my_jio.removeAttachment(attachment, [options]);
    Deletes a document’s attachment
    .allDocs()
    my_jio.allDocs([options]);
    Retrieves a list of existing documents
    .repair()
    my_jio.repair(document, [options]);
    Repairs the document

Download & Fork

You can get latest jIO release by using on of those links:

Full download Minified download

You can get latest RSVP release by using on of those links:

Full download Minified download

Fork jIO

Feel free to use the Gitlab repository:
GitLab: git clone https://lab.nexedi.com/nexedi/jio.git