indian-ocean

Indian Ocean

A library for reading in and writing out data in Node.js, part of The TK Toolkit.

Installation

npm install indian-ocean

Usage

var io = require('indian-ocean');

var json_data = io.readDataSync('path/to/data.csv');

console.log(json_data);

/*
[
  {
    "name": "Gerald",
    "occupation": "Teacher",
    "city": "Philadelphia"
  },
  {
    "name": "Marcy",
    "occupation": "Venture Capitalist",
    "city": "New York"
  }
]
/*

io.writeDataSync('path/to/save/output.json', json_data)

Methods

• Reading data
  • .readData(filepath, [delimiter], callback)
  • .readDataSync(filepath, [delimiter])
  • .readJson(filepath, callback)
  • .readJsonSync(filepath)
  • .readCsv(filepath, callback)
  • .readCsvSync(filepath)
  • .readTsv(filepath, callback)
  • .readTsvSync(filepath)
  • .readPsv(filepath, callback)
  • .readPsvSync(filepath)
• Writing data
  • .writeData(filepath, data, callback)
  • .writeDataSync(filepath, data)
• Helpers
  • .discernFormat(filepath)
  • .discernParser(filepath, [delimiter]
  • .discernFileFormatter(filepath)

Reading data

Reads a variety of data file formats in as json.

.readData(filepath, [delimiter], callback)

Reads in a data file given a path ending in the file format. Callback structure is function(err, data).

Supported formats:

• .json
• .csv Comma-separated
• .tsv Tab-separated
• .psv Pipe-separated

Pass in a delimiter as the second argument to read in another format.

.readDataSync(filepath, [delimiter])

Syncronous version of .readData()

.readJson(filepath, callback)

Read in a json file. Callback structure is function(err, data).

.readJsonSync(filepath)

Read json syncronously.

.readCsv(filepath, callback)

Read in a comma-separated value file. Callback structure is function(err, data).

.readCsvSync(filepath)

Read csv syncronously.

.readTsv(filepath, callback)

Read in a tab-separated value file. Callback structure is function(err, data).

.readTsvSync(filepath)

Read tsv syncronously.

.readPsv(filepath, callback)

Read in a pipe-separated value file. Callback structure is function(err, data).

.readPsvSync(filepath)

Read psv syncronously.

Writing data

Writes json objects to the specified format.

.writeData(filepath, data, callback)

Write out the data object, inferring the file format from the file ending specified in filepath. Callback structure is function(err).

Supported formats:

• .json
• .csv Comma-separated
• .tsv Tab-separated
• .psv Pipe-separated

.writeDataSync(filepath, data)

Syncronous version of .writeData.

Helpers

.discernFormat(filepath)

Given a filepath return its file extension. Used internally by .discernPaser and .discernFileFormatter.

E.g. tk.discernFormat('path/to/data.csv') returns 'csv'

.discernParser(filepath, [delimiter])

Given a filepath, optionally a delimiter, return a parser that can read that file as json. Used internally by .readData and .readDataSync.

E.g.

var csvParser = tk.discernParser('path/to/data.csv');

var json = parser('path/to/data.csv');

.discernFileFormatter(filepath)

Returns a formatter that will format json data to file type specified by the extension in filepath. Used internally by .writeData and .writeDataSync.

E.g.

var formatter = tk.discernFileFormatter('path/to/data.tsv');
var csv = formatter(json);

TODO

• Read/write dbf
• tests