JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 844
  • Score
    100M100P100Q99109F
  • License ISC

Parse key-value pairs (like environment variables)

Package Exports

  • parse-pairs
  • parse-pairs/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (parse-pairs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

parse-pairs

Package Version License PackagePhobia Node compatibility

Parse key-value pairs

Install

Installation of the npm package:

> npm install --save parse-pairs

Usage

import { parsePairs } from "parse-pairs";

parsePairs('Batman="Bruce Wayne" "Wonder Woman"="Diana Prince" # comment');
// {
//   Batman: 'Bruce Wayne',
//   'Wonder Woman': 'Diana Prince'
// }
  • both keys and values can be quoted
  • single and double quotes are supported
  • white spaces around pairs are ignored
  • no escape sequences, feel free to open an issue or PR if necessary
  • single line comments starting with # are ignored

Custom parser

For advanced needs, you can create a custom parser.

import { createParser } from 'parse-pairs'

const parse = createParser({
  keyTransform: lodash.cameCase,
  valueTransform: (value, key) => lodash.startCase(value.toLowerCase())
})

parse('BATMAN="BRUCE WAYNE" "WONDER WOMAN"="DIANA PRINCE"')
{
  batman: 'Bruce Wayne',
  wonderWoman: 'Diana Prince'
}

Contributions

Contributions are very welcomed, either on the documentation or on the code.

You may:

  • report any issue you've encountered;
  • fork and create a pull request.

License

ISC © Julien Fontanet