npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

file-conf

v2.0.1

Published

A structured configuration system with options for saving in multiple file formats.

Downloads

15

Readme

File Conf

A structured configuration system with options for saving in multiple file formats.

Usage

To use this package, you need to create your own configuration class that extends the FileConf class provided by this module. This allows you to expose values that you want available as well as validate input that you allow through during runtime. This package includes the zod npm package as its peer dependency. You must be able to write a zod schema to use this module.

Example

import { FileConf } from 'file-conf';
import z from 'zod';

const mySchema = z
  .object({
    mode: z.enum(['development', 'production']).default('development'),
    database: z
      .object({
        host: z.string().default('somewhere.net'),
        port: z.coerce.number().default(5432),
        user: z.string().default('REDACTED'),
        password: z.string().default('REDACTED')
      })
      .default({})
  })
  .strict()
  .default({});

/**
 * @typedef {object} ConfigSchema
 * @property {string} mode
 * @property {object} database
 * @property {string} database.host
 * @property {number} database.port
 * @property {string} database.user
 * @property {string} database.password
 */

class Config extends FileConf {
  constructor() {
    super(mySchema, { format: 'yaml' });
    /** @type {ConfigSchema} */
    this.$json;
  }
  get mode() {
    return this.$json.mode;
  }
  get database() {
    return this.$json.database;
  }
}

const c = new Config();

console.log(c.mode); //prints "development"
console.log(c.database.user); //prints "REDACTED"

const dbConf = { database: { user: 'admin' } };


//passing "true" saves valid changes to disk
console.log(c.update(dbConf, true);); //prints "true" because it was a valid update

console.log(c.update({notValid: 1}, true)) //prints false because it was an invalid update

console.log(c.database.user); //prints "admin"