artesanias/node_modules/stringify-package/README.md

stringify-package

stringify-package is a standalone library for writing out package data as a JSON file. It is extracted from npm.

Install

$ npm install stringify-package

Table of Contents

• Example
• Features
• Contributing
• API
  • stringifyPackage

Example

const fs = require('fs')
const pkg = { /* ... */ }

fs.writeFile('package.json', stringifyPackage(pkg), 'utf8', cb(err) => {
    // ...
})

Features

• Ensures consistent file indentation
  To match existing file indentation, detect-indent is recommended.

• Ensures consistent newlines
  To match existing newline characters, detect-newline is recommended.

Contributing

The npm team enthusiastically welcomes contributions and project participation! There’s a bunch of things you can do if you want to contribute! The Contributor Guide has all the information you need for everything from reporting bugs to contributing entire new features. Please don’t hesitate to jump in if you’d like to, or even ask us questions if something isn’t clear.

API

> stringifyPackage(data, indent, newline) -> String

Arguments

• data - the package data as an object to be stringified
• indent - the number of spaces to use for each level of indentation (defaults to 2)
• newline - the character(s) to be used as a line terminator