Releases: sindresorhus/conf
v5.0.0
This version does not have any breaking changes. It's a major version as it has an automatic migration-step for the encryptionKey
option. So if you're using that option, please continue reading.
Short story, Node.js deprecated the below APIs and we had to do encryption differently. Conf should be able to read both the new and old encryption format and it will write the new encryption format if you change any config. The migration is fully automatic, but please test your app thoroughly in case there are any issues.
v4.1.0
v4.0.2
v4.0.1
v4.0.0
Breaking
-
The config is now stored in
%APPDATA%
instead of%LOCALAPPDATA%
on Windows, which is more correct. There's unfortunately no automatic migration path. To continue using the old config location, runnpm i 'env-paths@^1.0.0'
and set thecwd
option:const Conf = require('conf'); const envPaths = require('env-paths'); const config = new Conf({ cwd: envPaths('<projectName>', {suffix: 'nodejs'}).config });
-
For TypeScript users only: Refactor TypeScript definition to CommonJS compatible export (#64) 277d70a
- You need to changeimport Conf from 'conf';
toimport Conf = require('conf');
Enhancements
- Add support for JSON schema (#58) 373afb9
- Fix path derivation logic (#62) bb26c4f