New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

@stone-js/config

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@stone-js/config

Fluent and simple API with deep dot access to manage configurations in JavaScript any project

  • 0.0.31
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
26
decreased by-57.38%
Maintainers
1
Weekly downloads
 
Created
Source

Stone.js: Config

npm npm npm Maintenance Publish Package to npmjs Conventional Commits

Fluent and simple API with deep dot access to manage configurations in any JavaScript project.


Synopsis

@stone-js/config is a versatile configuration management library that supports both vanilla JavaScript and TypeScript. It allows developers to easily manage application settings with features like nested configuration access, default value management, and proxy-based custom behavior for configuration properties.

Installation

To install the Config utility, you need to add it to your project. Assuming it’s part of a package you manage.

NPM:

npm i @stone-js/config

Yarn:

yarn add @stone-js/config

PNPM:

pnpm add @stone-js/config

The Config module can only be imported via ESM import syntax:

import * as Config from '@stone-js/config';

Getting Started

The Config library is designed to simplify configuration management in JavaScript and TypeScript projects. The library provides a Config class that allows you to create, access, modify, and clear configuration values, while also providing utility methods for managing defaults and nested properties.

The library is compatible with both vanilla JavaScript and TypeScript, providing strong type safety when used in TypeScript projects.

Usage

Importing the Library

To use the Config library, import the Config class from the installed package:

import { Config } from '@stone-js/config';

Creating a Config Instance

You can create a Config instance with an initial set of configuration values using the Config.create() method:

import { Config } from '@stone-js/config';

const config = Config.create({
  appName: 'MyApp',
  settings: {
    theme: 'dark',
    notifications: true
  }
});

Accessing Configuration Values

You can access configuration values using the get method. The get method also allows you to specify a fallback value if the key does not exist:

console.log(config.get('appName')); // Outputs: 'MyApp'
console.log(config.get('settings.theme')); // Outputs: 'dark'
console.log(config.get('settings.language', 'en')); // Outputs: 'en' (fallback value)

Setting Configuration Values

You can add or update configuration values using the set method:

config.set('settings.theme', 'light');
console.log(config.get('settings.theme')); // Outputs: 'light'

You can also set multiple values at once by passing an object:

config.set({
  'settings.language': 'fr',
  'settings.notifications': false
});
console.log(config.get('settings.language')); // Outputs: 'fr'

Checking for Configuration Values

To check if a particular configuration value exists, use the has method:

console.log(config.has('settings.theme')); // Outputs: true
console.log(config.has('settings.nonExistentKey')); // Outputs: false

Managing Default Values

The defaults method allows you to set default values for keys that do not already exist:

config.defaults('settings.fontSize', 'medium');
console.log(config.get('settings.fontSize')); // Outputs: 'medium'

Clearing Configuration

You can clear all configuration values using the clear method:

config.clear();
console.log(config.all()); // Outputs: {}

Working with Nested Properties

The Config class supports accessing and setting nested properties. You can use dot-notation strings to manage nested properties effectively:

console.log(config.get('settings.theme')); // Outputs: 'light'
config.set('settings.newFeature.enabled', true);
console.log(config.get('settings.newFeature.enabled')); // Outputs: true

Summary

The @stone-js/config library is a powerful and flexible solution for managing configuration in JavaScript and TypeScript applications. With support for nested properties, default value handling, and proxy-based custom behaviors, it provides a robust toolset for configuration management.

Key Features:

  • Simple API: Easy to use methods for creating, accessing, and modifying configuration values.
  • TypeScript Compatibility: Full TypeScript support for type safety and better development experience.
  • Nested Properties: Seamless handling of nested configuration values.
  • Default Value Management: Easily set and manage default values for configuration keys.

Start using @stone-js/config to simplify your application's configuration management and bring flexibility and robustness to your codebase.

API documentation

Contributing

See Contributing Guide.

Credits

Keywords

FAQs

Package last updated on 16 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc