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

peoplestring-stringify

v1.0.0

Published

generate strings like "Mary Smith <[email protected]> (https://marysmith.com) [SomeCo, Inc.]"

Downloads

4

Readme

The package exports a single function.

var stringify = require('peoplestring-stringify')

The function takes a single Object argument with any number of the following properties: name, email, url, and for. It returns a string that peoplestring-parse can read.

The following examples are also the test suite for the package. They use Node.js' built-in assert module.

var assert = require('assert')

A peoplestring can contain just a name.

assert.equal(
  stringify({ name: 'Mary Smith' }),
  'Mary Smith')

If the name has trailing whitespace, it's ignored.

assert.equal(
  stringify({ name: 'Mary Smith   ' }),
  'Mary Smith')

If the name has leading whitespace, it's ignored.

assert.equal(
  stringify({ name: '   Mary Smith' }),
  'Mary Smith')

A peoplestring can contain an e-mail address in angle brackets.

assert.equal(
  stringify(
    { name: 'Mary Smith',
      email: '[email protected]' }),
  'Mary Smith <[email protected]>')

A peoplestring can contain a URL in parentheses.

assert.equal(
  stringify({ name: 'Mary Smith',
    url: 'https://marysmith.com' }),
  'Mary Smith (https://marysmith.com)')

A peoplestring can contain the name of another person or company to show a person's contribution is a work made for hire for someone else.

assert.equal(
  stringify(
    { name: 'Mary Smith',
      for: 'SuperCo, Inc.' }),
  'Mary Smith [SuperCo, Inc.]')

A peoplestring can contain a name, an e-mail address, and a URL.

assert.equal(
  stringify(
    { name: 'Mary Smith',
      email: '[email protected]',
      url: 'https://marysmith.com' }),
  'Mary Smith <[email protected]> (https://marysmith.com)')

A peoplestring can contain just an e-mail address in angle brackets.

assert.equal(
  stringify({ email: '[email protected]' }),
  '<[email protected]>')

A peoplestring can contain just a URL in parentheses.

assert.equal(
  stringify({ url: 'https://marysmith.com' }),
  '(https://marysmith.com)')

A peoplestring can contain just the name of the work make for hire owner.

assert.equal(
  stringify({ for: 'SuperCo, Inc.' }),
  '[SuperCo, Inc.]')

The function throws when passed a non-string arguments.

assert.throws(
  function () {
    stringify('already a string!') })