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

@burnsred/defaults

v1.0.0

Published

A system for providing project-wide defaults to libraries.

Downloads

142

Readme

Defaults

A system for providing project-wide defaults to libraries.

Setup

First, define your defaults object.

This will map lookup keys to any sort of value. It can be nested to help with specialised scoping.


export default {
    foo: FooComponent,

    routes: {
        foo: RoutedFoo,
        members: {
            foo: SpecialFooComponent,
        },
    },
}

In your code, use the hooks to access them:

  1. Direct lookup
const foo = useDefault("foo"); // Will return `FooComponent`

The lookup key can contain dots, in which case it will drill down into objects.

const foo = useDefault("routes.foo");  // Will return `RoutedFoo`
  1. Defaults Map

Will find the first matching (non-undefined) lookup for each key from its list of lookups.


const foo = useDefaultMap({
    foo: ["routes.members.foo", "routes.foo"],
})

This will first check for default["routes"]["members"]["foo"], and if that's undefined, try default["routes"]["foo"], finally resorting to default["foo"].

  1. Fill defaults

Use the fallback defaults method to fill absent entries on an object.


const fullProps = useFillDefaults(props, defaultsMap);

Any keys from defaultsMap that are not present in props will be resolved as with useDefaultMap.

  1. Scoped lookup

All of the above hooks acception an optional scope argument.

This can be useful to, for instance, provide a typed default proxy for lookups within a certain section of the defaults object:

function useDefaultWidget(key: string): Widget {
    return useDefault(key, 'widgets') as Widget;
}