properties-file

What is properties-file?

The properties-file npm package allows you to read, write, and manipulate .properties files, which are commonly used for configuration settings in Java applications. This package provides a simple API to handle these files in a Node.js environment.

What are properties-file's main functionalities?

Read properties file

This feature allows you to read a .properties file and parse its contents into a JavaScript object. The `read` method takes the file path as an argument and returns an object with key-value pairs.

const properties = require('properties-file');
const config = properties.read('config.properties');
console.log(config);

Write properties file

This feature allows you to write a JavaScript object to a .properties file. The `write` method takes the file path and the object to be written as arguments.

const properties = require('properties-file');
const config = { key1: 'value1', key2: 'value2' };
properties.write('config.properties', config);

Update properties file

This feature allows you to update an existing .properties file. You can read the file into a JavaScript object, modify the object, and then write it back to the file.

const properties = require('properties-file');
let config = properties.read('config.properties');
config.key3 = 'value3';
properties.write('config.properties', config);

Other packages similar to properties-file

properties-reader

The properties-reader package provides similar functionality for reading and manipulating .properties files. It offers a more fluent API for accessing properties and supports nested properties. Compared to properties-file, it may be more user-friendly for complex configurations.

node-properties

The node-properties package is another alternative for handling .properties files. It provides basic read and write capabilities but lacks some of the advanced features found in properties-file. It is a simpler option for straightforward use cases.

config

The config package is a more comprehensive solution for managing configuration files in Node.js applications. It supports multiple file formats, including .properties, JSON, and YAML. While it offers more features, it may be overkill for simple .properties file manipulation.

README

Just parse .properties files which used in firefox localization

Install

npm i properties-file

Usage

Parse .properties file

var parser = require("properties-file");

var object = parser.parse(propertiesFileContents);
// object with key value strings
// for example if you have .properties file:
// str1=text1
// str2=text2
// you will get object like this:
// {
//   "str1": "text1",
//   "str2": "text2"
// }

Generate properties file from object

var parser = require("properties-file");

var string = parser.stringify({
  str1: "text1",
  str2: "text2"
});
// string will be
// str1=text1
// str2=text2