Optify Bindings for Node.js

See the homepage for details about how feature files are combined to build the options to process at runtime.

Usage

import { OptionsProvider } from '@optify/config'

const provider = OptionsProvider.build('<configs folder path>')
const options = JSON.parse(provider.getOptionsJson('myConfig', ['feature_A', 'feature_B']))
console.log(JSON.stringify(options, null, 2))

Outputs:

{
  "myArray": [
    "item 1",
    "item 2"
  ],
  "myObject": {
    "deeper": {
      "new": "new value",
      "num": 3333
    },
    "key": "val",
  },
  "rootString": "root string same"
}

Multiple directories can be used as well:

import { OptionsProvider } from '@optify/config'

const provider = OptionsProvider.buildFromDirectories(['<configs folder path>', '<another folder path>'])
const options = JSON.parse(provider.getOptionsJson('myConfig', ['feature_A', 'feature_B']))
console.log(JSON.stringify(options, null, 2))

Development

Use Node >= 22.

corepack enable
yarn install
yarn build:debug
yarn build:ts
yarn test

Testing

Run:

yarn build:debug
yarn build:ts
yarn test

Benchmarking

Run:

rm -rf target config.*.node
yarn build
yarn build:ts
node benchmarks/get_all_options.mjs

Formatting

To automatically change the Rust code, run:

cargo fmt

Publishing

Use CI.

Some notes:

See https://napi.rs/docs/introduction/getting-started#deep-dive
See https://napi.rs/docs/introduction/simple-package