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

ssm-params

v0.1.0

Published

Obtain from AWS SSM Parameter Store

Downloads

3,626

Readme

ssm-params

Obtain parameters from AWS SSM Parameter Store.

Installation

npm i ssm-params aws-sdk -S

API

ssmToObj(options, callback)

  • options
    • If this is a string, it is equivalent to specify options.prefix only.
  • options.prefix
    • A prefix of parameter names to obtain parameters.
  • options.target
    • A target object that is set values of obtained parameters.
    • Default: {}
  • options.withDecryption
    • If this is true, values of secure strings are decrypted.
  • callback(err, target)
    • A callback which is called, when obtaining parameters have finished or an error occurs.
    • If no error occurs, options.target passes into target.

ssmToObjByPath(options, callback)

  • options
    • If this is a string, it is equivalent to specify options.Path only.
  • options.target
    • A target object that is set values of obtained parameters.
    • Default: {}
  • options.nestObject
    • A boolean value that determines whether to make a nested object from obtained parameters.
    • If this option is true, options.Recursive is also treated as true.
    • Default: false
  • options.trimPath
    • A boolean value that determines whether to trim the hierarchy path from the name of obtained parameters.
    • Default: true
  • options.Path
    • A hierarchy path to obtain parameters.
  • options.Recursive
    • A boolean value that determines whether to obtain parameters recursively.
    • Default: false
  • options.WithDecryption
    • If this is true, values of secure strings are decrypted.
    • Default: false
  • options.ParameterFilters
    • An array of objects describing the conditions of the parameters to be retrieved.
  • callback(err, target)
    • A callback which is called, when obtaining parameters have finished or an error occurs.
    • If no error occurs, options.target passes into target.

ssmToEnv(prefix, [recursive,] callback)

This is equivalent to call ssmToObj or ssmToObjByPath with specifying process.env to a target.

  • prefix
    • This is equivalent to options.prefix of ssmToObj.
    • If this argument starts with '/', this function calls ssmToObjByPath instead of ssmToObj.
  • recursive
    • This is equivalent to options.Recursive of ssmToObjByPath.
  • callback(err, target)
    • This is equivalent to callback of ssmToObj.

Required IAM Permissions

  • ssm:DescribeParameters
  • ssm:GetParameters

License

MIT