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

oscuro

v2.0.0

Published

read from a list of files and get only the first one that returns

Downloads

7

Readme

Oscuro

Provide oscuro with a list of files and you'll only get the first one back that exists. Useful for looking for config files in different places. Similar to cosmiconfig (great package!) but less batteries included.

API

Oscuro exports a function.

const promise = oscuro([
    './file1.json', 
    'file2.yaml', 
    'file3.js', 
    { path: "./.file5", type: "json" }, 
    { path: "./file6.json", key: "path.to.my.prop" }, 
    'file4.html'
], "default thing to give if none are found");

paths: array of strings and objects, required. First param is a list of paths to try to read, in order. Every path will be read and it will wait until all resolve before returning your answer. Items in the array can be strings or objects.

Objects must have a path prop and may have a type prop and/or a key prop. Type will tell it how to interept the data. json and yaml are parsed and returned as objects. js is required and returned. Anything else is returned as a string. The type is inferred from the path if no type is provided. key prop will use lodash's get method to return only part of the object that you specify.

defaultResponse: mixed, optional. what to be passed back if none of the paths resolve.

License

Apache 2.0