Skip to content

kodedninja/datta

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

datta

A readable plain text structure for strictly formatted data

Installation

npm i datta

Usage

var datta = require('datta')

var str = datta.parse(`
ID  NAME         EMAIL
---
000 RANDOM JOE   joe@mail.com
# some comment
001 RANDOM JERRY jerry@mail.com
`)

var obj = datta.stringify([
	{ ID: 0, NAME: 'RANDOM JOE', EMAIL: 'joe@mail.com' },
	{ ID: 1, NAME: 'RANDOM JERRY', EMAIL: 'jerry@mail.com' }
])

You can also require just a single method:

var stringify = require('datta/stringify')
var parse = require('datta/parse')

API

stringify(obj)

Accepts a single object. Returns a string.

parse(str)

Accepts a single string. Returns an object.

Structure

The header contains the names of the fields that are separated by spaces. The spaces define the max length of the value.

The --- separates the header from the content.

The content forms columns (every field begins where its name is in the header). The last column is basically doesn't have defined length.

Lines beginning with # are comments.

Releases

No releases published

Packages

No packages published