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

urn-parser

v1.0.1

Published

Module that has utilities for URN parsing

Downloads

11

Readme

urn-parser - Module for URN parsing

Overview

URN-Parser is a module that provides functions for parsing URN (Uniform Resource Name) that is loosly based upon the standard url module within node. Parsing is derived from the excellent parseUri function by Steven Levithan, but stripped down for the urn scheme.

Although the URN-parser is a good start, for a more complete and fully compliant implemnentation I recommend you take a look at the URI Type for javascript module which allows the urn to be inspected as an uri.

What's an URN?

The best place to start if you want to know more about URNs is (of course) the wikipedia article on Uniform Resource Name.

Installation

npm install urn-parser

Using the Module

The 'urn-parser' module is accessed in the standard way by calling require("urn-parser"); and once loaded you have access to the following objects and functions.

Class urn-parser.Parser

The Parser class is a wrapper object class that provides access to an object that can be used to parse urn instances.

This class has the following interface:

Constructor Parser(options)

Creates a new instance with the specified options

Method Parser.parse(urnStr, strictMode)

Parses an URN into components (optionally in strict mode)

Method Parser.complete(obj)

Creates a complete URN definition from its components

Method Parser.format(obj)

Formats an URN definition into a well-formed URN string

Function urn-parser.parse

The parse function is a proxy to the Parser.parse(urnStr, strictMode) method on a singleton Parser instance that is created for the module.

Function urn-parser.complete

The complete function is a proxy to the Parser.complete(obj) method on a singleton Parser instance that is created for the module.

Function urn-parser.format

The format function is a proxy to the Parser.format(obj) method on a singleton Parser instance that is created for the module.

Contributors

License

MIT License

Acknowledgements


Author

Stuart Hudson