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

@rlmartin/config-loader

v1.0.1

Published

Utility class/functions to help load config from various sources.

Downloads

107

Readme

ConfigLoader

Utility class/functions to help load config from various sources.

Initial implementation narrowly supports AWS Lambda, but may be expanded to additional uses cases in the future.

Usage

The ConfigLoader class takes a type argument to strongly define the expected config variable names. Because the config can be loaded from multiple sources, there is no check of the existence of every variable until is is attempted to be used.

To use the loader, create a small file like this:

import { Context } from 'aws-lambda';
import { ConfigLoader } from '@rlmartin/config-loader';

export interface Config {
  readonly FOO: string;
  readonly BAR: string;
}

var config: ConfigLoader<Config>;

export async function loadConfig(context: Context) {
  config = new ConfigLoader<Config>(context);
  await config.load();
}

export function getConfig(key: keyof Config): Config[typeof key] {
  return config.get(key);
}

then when config is needed:

import { Context, S3Event } from 'aws-lambda';
import { getConfig, loadConfig } from './config';

export async function handler(event: S3Event, context: Context): Promise<void> {
  await loadConfig(context);
  const foo = getConfig('FOO');
  // ...
}

Supported config sources

The config is loaded from all of the following sources, in order of precedence (higher will override lower):

  1. Secrets Manager
  2. Environment variables (process.env)

Secret name

The secret name matches the AWS Lambda function name.

Nested secrets

It is possible to load values from other secrets by setting the value to:

{
  'propertyName': { '$ref':'secretName' }
}

where secretName is the name of the secret that should be loaded as the value for propertyName. The value in the dependent secret can be any value (JSON or otherwise). This loading is recursive.

Be careful to not load too many dependent secrets and/or nest too deeply - because a) SecretsManager pricing is based on the number of secrets loaded and b) it could adversely affect load times.

This same secret-loading process can be utilized by env vars, e.g.

process.env['propertyName'] = '{"$ref":"secretName"}';