stringify-author

Stringify an authors object to name <email> (url).

Install

Install with npm

$ npm i stringify-author --save

Usage

var stringify = require('stringify-author');

var authors = stringify({
  name: 'Jon Schlinkert',
  email: 'jon.schlinkert@sellside.com',
  url: 'https://github.com/jonschlinkert'
});

console.log(authors);
//=> 'Jon Schlinkert <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)'

Any of the properties can be used or missing:

var authors = [
  {name: 'Brian Woodward', url: 'https://github.com/doowb'},
  {name: 'Jon Schlinkert', url: 'https://github.com/jonschlinkert'}
];

console.log(authors.map(stringify));
//=> [ 'Brian Woodward (https://github.com/doowb)', 'Jon Schlinkert (https://github.com/jonschlinkert)' ]

Similar or related projects

author-regex: Regular expression for parsing an author string into an object following npm conventions. | homepage
parse-author: Parse a string into an object with name, email and url properties following npm conventions.… more | homepage
parse-authors: Parse a string into an array of objects with name, email and url properties following… more | homepage
stringify-authors: Converts an author object or array of author objects into an array of strings. Useful… more | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

License

This file was generated by verb-cli on November 22, 2015.

Current Tags

0.1.3 ... latest (9 years ago)

4 Versions

0.1.3 ... 9 years ago
0.1.2 ... 9 years ago
0.1.1 ... 10 years ago
0.1.0 ... 10 years ago