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

parameter-store

v0.0.11

Published

Fetch key/value pairs from AWS Parameter Store and set them as environmental variables.

Downloads

17

Readme

parameter-store

This is a tiny package comprised of three utility functions to handle loading environmental variables/secrets from AWS SSM.

loadEnv can be used to load environmental variables from SSM at a particular path/hierarchy into process.env.

patchEnv patches a plain object with values from AWS SSM using the syntax { SUPER_SECRET: "${ssm:/app/SECRET}" }

patchJson patches a json configuration file using patchEnv.

Example

Basic Usage

loadEnv(path: string, config: { region: 'us-east-1' }) => Promise<{}>

loads environmental variables at a hierarchy into process.env.

const { loadEnv } = require('parameter-store')

loadEnv('/prefix', { region: 'us-east-1' })
 .then(() => console.log(process.env))

patchEnv(environment: {}) => Promise<{}>

Takes a plain object, where some values are expected to refer to an SSM parameter using the familiar serverless syntax: "${ssm:PATH_TO_ENV_VAR}".

const { patchEnv } = require('parameter-store')

const env = {
  "PORT": "3000",
  "API_KEY": "${ssm:/app/API_KEY}"
}

patchEnv(env, { region: 'us-east-1' })
 .then(patched => {
   console.log(patched)
   // => {
   //  "PORT": "3000",
   //  "API_KEY": "03cae8ea-48c2-4fd0-aa70-533e0cf4a801"
   // }
 })

patchJson(path: string, key: string | Array<string>, config: { 'us-east-1' }) => Promise<() => void>

  • path: path to a json configuration file
  • key: a key to get the environment object to mutate (uses lodash.get)
  • config: AWS configuration for new AWS.SSM(config)

Returns a restore function that restores the json configuration file to its original state.

in up.json:

{
  "name": "app",
  "environment": {
    "API_KEY": "${ssm:/app/API_KEY}"
  }
}
const { patchJson } = require('parameter-store')

patchJson('up.json', 'environment')
  .then(restore => {
    console.log(require('fs').readFileSync('up.json'))
    // {
    //  "name": "app",
    //  "environment": {
    //    "API_KEY": "03cae8ea-48c2-4fd0-aa70-533e0cf4a801"
    //  }
    // }
    restore() // restore up.json to original state
  })