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

@msamblanet/node-config-types

v0.4.0

Published

TS types and utility methods for @msamblanet packages

Downloads

5

Readme

Node Config Types

npm version License

This repository is part of a collection of my personal node.js libraries and templates. I am making them available to the public - feel free to offer suggestions, report issues, or make PRs via GitHub.

This project provides a minimal implementation of types and base classes for configurable components to allow for consistent usages across projects.

The sample below is provided in example-module.ts for use as a template for new components (if desired).

Variations of BaseConfigurable are provided to account for logging classes and event emitters. The full list of base clases are:

  • BaseConfigurable<C>
  • BaseEmittingConfigurable<C> - Subclasses EventEmitter
  • BaseLoggingConfigurable<C,L> - Exposes log in a protected member
  • BaseLoggingEmittingConfigurable<C,L> - Exposes log in a protected member, subclasses EventEmitter
  • In all of the above:
    • C is the type of the config and defaults to IConfig
    • L is the type of the logger and it defaults to ILogAdapter from @msamblanet/slf4j (but can be anything)
import { IConfig, Overrides, mergeOptions, BaseLoggingConfigurable } from '@msamblanet/node-config-types';

export type IExampleLogger = unknown;

// ********************************************************

export interface FooConfig {
  a: number;
  b: number;
}

export class SimpleFoo extends BaseLoggingConfigurable<FooConfig, IExampleLogger> {
  public static readonly DEFAULT_CONFIG = { a: 1, b: 2 };

  public constructor(log: IExampleLogger, ...config: Overrides<FooConfig>) {
    super(log, SimpleFoo.DEFAULT_CONFIG, ...config);
  }

  public someMethod(): number {
    return this.config.a + this.config.b;
  }
}

// ********************************************************

export interface AbstractFooConfig {
  a: number;
  b: number;
}

export abstract class AbstractFoo<X extends AbstractFooConfig = AbstractFooConfig> extends BaseLoggingConfigurable<X, IExampleLogger> {
  public static readonly DEFAULT_CONFIG = { a: 1, b: 2 };

  public constructor(log: IExampleLogger, defaults: X, ...overrides: Overrides<X>) {
    super(log, defaults, ...overrides);
  }

  public abstract someMethod(): number;
}

// ********************************************************

export interface ConcreteFooConfig extends AbstractFooConfig {
  c: number;
}

export class ConcreteFoo extends AbstractFoo<ConcreteFooConfig> {
  public static readonly DEFAULT_CONFIG: ConcreteFooConfig = mergeOptions<ConcreteFooConfig>(AbstractFoo.DEFAULT_CONFIG, {
    b: 42,
    c: 3
  });

  public constructor(log: IExampleLogger, ...overrides: Overrides<ConcreteFooConfig>) {
    super(log, ConcreteFoo.DEFAULT_CONFIG, ...overrides);
  }

  public someMethod(): number {
    return this.config.a + this.config.b + this.config.c;
  }
}