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

@stamp/configure

v1.0.2

Published

Access configuration of your stamps anywhere

Downloads

155

Readme

@stamp/configure

Access configuration of your stamps anywhere

Configuration is powerful feature of stamps as it allows you to store additional information with the stamp without interfering with properties or methods. Consider following example.

Usage

import compose from '@stamp/compose'
import jwt from 'jsonwebtoken'

const Jwt = compose({
  configuration: {
    jwtSecret: process.env.SECRET,
  },
  initializers: [
    initializeJwt(_, { stamp }) {
      const { jwtSecret } = stamp.compose.configuration
      ...
      this.createJwtToken = (payload) => jwt.sign(payload, jwtSecret)
      this.verifyJwtToken = (token) => jwt.verify(token, jwtSecret)
    }
  ]
})

That approach brings several advantages.

  • Clearly specify what makes the stamp tick.
  • Configured values are immutable.
  • Stamp with a modified configuration can be made.

The last bullet is especially useful for automated testing allowing you to insert different values based on various conditions. Unfortunately, there is apparent boilerplate hidden behind this, and it can get tedious for a larger project.

Now consider next example that is using @stamp/configure stamp.

import Configure from '@stamp/configure'
import jwt from 'jsonwebtoken'

const Jwt = Configure.compose({
  configuration: {
    jwtSecret: process.env.SECRET,
  },
  methods: {
    createJwtToken(payload) {
      return jwt.sign(payload, this.config.jwtSecret)
    },
    verifyJwtToken(token) {
      return jwt.verify(token, this.config.jwtSecret)
    }
  }
})

Looks good, doesn't it? But wait, all those advantages of the configuration are suddenly gone, right? Not exactly.

Under the hood, we are using @stamp/privatize stamp. That allows us to access this.config within our methods and yet keep them hidden from outside world. Immutability is ensured by using Object.freeze().

The deepConfiguration gets assigned to the same this.config object as well while the configuration has a precedence over it. In case of name conflict, the value from configuration always wins.

No fan of @stamp/privatize ?

By including @stamp/configure your whole stamp is privatized by default which you may not like that much. For that case, we are offering opt-out option of using Configure.noPrivatize() instead of plain Configure.