Java-props NPM

java-props

Read/Parse Java .properties files (using EXACTLY the same specification) in Javascript (browser) and Node.js.

This module provides its own TypeScript declarations (.d.ts).

Installation

npm install java-props

Example

# file.properties
a = Hello World
b : Node.js\u00AE
c value
d=foo\
  bar

const javaProps = require('java-props');

javaProps
    .parseFile('./file.properties')
    .then((props) => {
        console.log(props);
        // { a: 'Hello World', b: 'Node.js®', c: 'value', d: 'foobar' }
    })
    .catch((err) => {
        console.error(err);
    });

Documentation

For a detailed API reference, see: node-java-props.nathan818.fr

Building

This project uses TypeScript. To create javascript sources run:

yarn run build

Testing

To run the test suite, first install the dependencies, then run yarn test:

yarn install
yarn test

Contributing

Contributions are welcome.

The goal is to keep a simple project without unnecessary (non essential) features. It is recommended to open an issue before introducing new features to discuss them.