Skip to content

andcastillo/jcampconverter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JCAMP converter

NPM version build status npm download

Parse and convert JCAMP data

Installation

Node JS

npm install jcampconverter

Bower

bower install jcampconverter

Methods

convert(jcamp, [options], [useWorker])

Converts the jcamp using options.

Arguments

  • jcamp - String containing the JCAMP data
  • options - Object with options to pass to the converter
  • useWorker - Browser only: convert in a web worker (default: false). If this option is set to true, it will return a Promise.

Options

  • keepSpectra - Generate array for 2D NMR spectra (default: false)
  • keepRecordsRegExp - regexp to select which records should be placed in the info field. By default: :/^$/} (nothing is kept)
  • xy - instead of creating a 1D array containing [x1,y1,x2,y2, ...] create an object: {x:[], y:[]}

Use as a module

Node JS

var converter = require('jcampconverter');
var jcamp = require('fs').readFileSync('path/to/jcamp.dx').toString();

var result = converter.convert(jcamp);

AMD

require(['jcampconverter'], function(JcampConverter) {
    // Use the worker
    JcampConverter.convert(jcamp, true).then(function (result) {
        // Do something with result
    });
});

Testing and build

npm install
npm test
npm run build

Benchmark

npm run benchmark

How to create the tests

http://unitjs.com/guide/should-js.html

License

MIT

About

Convert JCAMP data to javascript objects

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •