# mgf-generator

> Generate an MGF out of a JSON file.

Latest version **0.1.1** (published 2020-04-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install mgf-generator
pnpm add mgf-generator
yarn add mgf-generator
bun add mgf-generator
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2020-04-17 |
| First published | 2020-04-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Océane Patiny |
| Maintainers | opatiny |

## Links

- npm: https://www.npmjs.com/package/mgf-generator
- Repository: https://github.com/cheminfo/mgf-generator
- Homepage: https://github.com/cheminfo/mgf-generator#readme
- Issues: https://github.com/cheminfo/mgf-generator/issues
- npm.io page: https://npm.io/package/mgf-generator

## Recent versions

- 0.1.1 (latest) — 2020-04-17
- 0.1.0 — 2020-04-17

## README

# mgf-generator

[![NPM version][npm-image]][npm-url]
[![build status][ci-image]][ci-url]
[![npm download][download-image]][download-url]

Generate an MGF out of a JSON file. This package is complementary to [`mgf-parser`](https://github.com/cheminfo/mgf-parser).

## Installation

`$ npm i mgf-generator`

## Usage

```js
import { readFileSync } from 'fs';
import { join } from 'path';

import generateMGF from 'mgf-generator';

let parsedData = readFileSync(join(__dirname, './data/test.json'), 'utf8');

parsedData = JSON.parse(parsedData);

let result = generateMGF(parsedData);

// result is a string in MGF format
```

## [API Documentation](https://cheminfo.github.io/mgf-generator/)

## License

[MIT](./LICENSE)

[npm-image]: https://img.shields.io/npm/v/mgf-generator.svg
[npm-url]: https://www.npmjs.com/package/mgf-generator
[ci-image]: https://github.com/cheminfo/mgf-generator/workflows/Node.js%20CI/badge.svg?branch=master
[ci-url]: https://github.com/cheminfo/mgf-generator/actions?query=workflow%3A%22Node.js+CI%22
[download-image]: https://img.shields.io/npm/dm/mgf-generator.svg
[download-url]: https://www.npmjs.com/package/mgf-generator

---
_Source: https://npm.io/package/mgf-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._