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

@web4/resolve-bit-path

v1.0.0

Published

Resolves a file within a BIT archive based on how web browsers would load it

Downloads

3

Readme

resolve-bit-path

Resolves a file within a BIT archive based on how web browsers would load it.

const resolveBitPath = require('@web4/resolve-bit-path')

const archive = getABitdrivedriveSomehow();

const rawPath = '/blog/about'

try {
  const {type, path, stat} = await resolveBitPath(archive, rawPath)
  if(type === 'directory') {
    console.log('Render the file list from the folder signified by `path`')
  } else if(type === 'file') {
    console.log('Render the file at `path`')
  } else {
    console.error('Something went horribly wrong')
  }
} catch (err) {
  console.log('Show your application 404 page')
}

How it works

How the algorithm for looking up paths works:

  1. It will look for the web_root property in the /bit.json file to use as prefix, if non-existent it will use /.

  2. It will look for a file to be returned, with following order at:

    1. exactly the path
    2. with an .html suffix
    3. with an .md suffix
    4. with an /index.html suffix
    5. with an /index.md suffix
  3. It will look for a folder to be returned at the given path.

  4. It will look for the fallback_page property in the /bit.json, will return the file for the path:

    1. if it exists as is
    2. if it exists with the web_root prefix
  5. It will throw an Not Found error.

License

MIT