# alinex-format > Parse and format multiple data serialization types. Latest version **1.2.0** (published 2017-04-18) · Apache-2.0 license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install alinex-format pnpm add alinex-format yarn add alinex-format bun add alinex-format ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 1.2.0 | | Published | 2017-04-18 | | First published | 2016-06-07 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.10 | | Dependencies | 12 | | Known vulnerabilities | 0 (+3 in 2 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | Alexander Schilling | | Maintainers | alinex | | Keywords | serialization, deserialization, stringify, parse, xml, json, bson, cson, yaml, csv, properties, ini | ## Links - npm: https://www.npmjs.com/package/alinex-format - Repository: https://github.com/alinex/node-format - Homepage: http://alinex.github.io/node-format - Issues: https://github.com/alinex/node-format/issues - npm.io page: https://npm.io/package/alinex-format ## Dependencies (12) - [ini](https://npm.io/package/ini.md) ^1.3.4 - [bson](https://npm.io/package/bson.md) ^1.0.4 - [async](https://npm.io/package/async.md) ^2.3.0 - [chalk](https://npm.io/package/chalk.md) ^1.1.3 - [debug](https://npm.io/package/debug.md) ^2.6.3 - [xml2js](https://npm.io/package/xml2js.md) ^0.4.17 - [js-yaml](https://npm.io/package/js-yaml.md) ^3.8.3 - [csv-parse](https://npm.io/package/csv-parse.md) ^1.2.0 - [properties](https://npm.io/package/properties.md) ^1.2.1 - [cson-parser](https://npm.io/package/cson-parser.md) ^1.3.5 - [coffee-script](https://npm.io/package/coffee-script.md) ^1.12.5 - [csv-stringify](https://npm.io/package/csv-stringify.md) ^1.0.4 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 1.2.0 (latest) — 2017-04-18 - 1.1.5 — 2016-10-04 - 1.1.4 — 2016-10-04 - 1.1.3 — 2016-06-07 ## README Alinex Format: Readme ================================================= [![GitHub watchers]( https://img.shields.io/github/watchers/alinex/node-format.svg?style=social&label=Watch&maxAge=2592000)]( https://github.com/alinex/node-format/subscription) [![GitHub stars]( https://img.shields.io/github/stars/alinex/node-format.svg?style=social&label=Star&maxAge=2592000)]( https://github.com/alinex/node-format) [![GitHub forks]( https://img.shields.io/github/forks/alinex/node-format.svg?style=social&label=Fork&maxAge=2592000)]( https://github.com/alinex/node-format) [![npm package]( https://img.shields.io/npm/v/alinex-format.svg?maxAge=2592000&label=latest%20version)]( https://www.npmjs.com/package/alinex-format) [![latest version]( https://img.shields.io/npm/l/alinex-format.svg?maxAge=2592000)]( #license) [![Travis status]( https://img.shields.io/travis/alinex/node-format.svg?maxAge=2592000&label=develop)]( https://travis-ci.org/alinex/node-format) [![Coveralls status]( https://img.shields.io/coveralls/alinex/node-format.svg?maxAge=2592000)]( https://coveralls.io/r/alinex/node-format?branch=master) [![Gemnasium status]( https://img.shields.io/gemnasium/alinex/node-format.svg?maxAge=2592000)]( https://gemnasium.com/alinex/node-format) [![GitHub issues]( https://img.shields.io/github/issues/alinex/node-format.svg?maxAge=2592000)]( https://github.com/alinex/node-format/issues) This package will give you an easy way to serialize and deserialize different data objects into multiple formats. The major features are: - easy to use - load format libraries on demand - auto detection > It is one of the modules of the [Alinex Namespace](https://alinex.github.io/code.html) > following the code standards defined in the [General Docs](https://alinex.github.io/develop). __Read the complete documentation under [https://alinex.github.io/node-format](https://alinex.github.io/node-format).__ Install ------------------------------------------------- [![NPM](https://nodei.co/npm/alinex-format.png?downloads=true&downloadRank=true&stars=true) ![Downloads](https://nodei.co/npm-dl/alinex-format.png?months=9&height=3) ](https://www.npmjs.com/package/alinex-format) The easiest way is to let npm add the module directly to your modules (from within you node modules directory): ``` sh npm install alinex-format --save ``` And update it to the latest version later: ``` sh npm update alinex-format --save ``` Always have a look at the latest [changes](Changelog.md). Usage ------------------------------------------------- To use the format you have to load the module first: ``` coffee format = require 'alinex-format' ``` This gives you back the main format instance which holds two methods to use: ### stringify Serialize data object into string. __Arguments:__ * `obj` object to be formatted * `format` format to use or filename to read format from * `options` (optional) specific for the format * `cb` callback will be called with (err, text) ### parse Try to parse object from string. Auto detect if no format is given. __Arguments:__ * `string` text to be parsed * `format` (optional) format to use or filename to read format from * `cb` callback will be called with (err, object) License ------------------------------------------------- (C) Copyright 2016 Alexander Schilling Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at > Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --- _Source: https://npm.io/package/alinex-format · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._