Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

fellow

bevry6.7kArtistic-2.07.4.0TypeScript support: included

Fellow is a package for creating people that can be unified by their shared values via a singleton list on the class

author, authors, browser, contributor, contributors, deno, deno-edition, deno-entry, denoland, es2017, es2022, export-default, fellow, github user, maintainer, maintainers, module, node, people, person, typed, types, typescript, user

readme

fellow

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

Fellow is a package for creating people that can be unified by their shared values via a singleton list on the class

Usage

Complete API Documentation.

Install

npm

  • Install: npm install --save fellow
  • Import: import pkg from ('fellow')
  • Require: const pkg = require('fellow').default

Deno

import pkg from 'https://unpkg.com/fellow@^7.4.0/edition-deno/index.ts'

Skypack

<script type="module">
    import pkg from '//cdn.skypack.dev/fellow@^7.4.0'
</script>

unpkg

<script type="module">
    import pkg from '//unpkg.com/fellow@^7.4.0'
</script>

jspm

<script type="module">
    import pkg from '//dev.jspm.io/fellow@7.4.0'
</script>

Editions

This package is published with the following editions:

  • fellow aliases fellow/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment
  • fellow/source/index.ts is TypeScript source code with Import for modules
  • fellow/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
  • fellow/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 14 || 16 || 18 || 20 || 21 with Require for modules
  • fellow/edition-es2017/index.js is TypeScript compiled against ES2017 for Node.js 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
  • fellow/edition-es2017-esm/index.js is TypeScript compiled against ES2017 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
  • fellow/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
  • fellow/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Maintainers

Contributors

Finances

GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

Sponsors

  • Andrew Nesbitt — Software engineer and researcher
  • Balsa — We're Balsa, and we're building tools for builders.
  • Codecov — Empower developers with tools to improve code quality and testing.
  • Frontend Masters — The training platform for web app engineering skills – from front-end to full-stack! 🚀
  • Mr. Henry
  • Poonacha Medappa
  • Rob Morris
  • Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
  • Syntax — Syntax Podcast

Donors

License

Unless stated otherwise all works are:

and licensed under:

changelog

History

v7.4.0 2024 January 8

v7.3.0 2024 January 8

v7.2.1 2023 December 30

v7.2.0 2023 December 29

v7.1.2 2023 December 28

v7.1.1 2023 December 28

v7.1.0 2023 December 27

v7.0.4 2023 December 27

v7.0.3 2023 December 27

  • Renamed githubRepoSlug to githubSlug
  • Emails are now verified before being applied
  • Add verifyUrls method
  • Use bevry/render for rendering
  • Add toFormat method
  • URLs are without schema are now corrected to https:// and www. removed
  • Fixed description outputs containing : instead of :
  • Thank you to the sponsors: Andrew Nesbitt, Balsa, Codecov, Poonacha Medappa, Rob Morris, Sentry, Syntax

v7.0.2 2023 December 21

  • Renamed toHTML to toHtml to be consistent with other naming
  • toText now respects FormatOptions.urlFields
  • toMarkdown and toHtml now respect FormatOptions.displayDescription

v7.0.1 2023 December 21

  • Prevent fellows that use their company url as their homepage from being merged together, now idFields prefers emails and uses usernames instead of urls as intended
  • Remove prefix option, such parental rendering extensions are best handled outside the scope of the children
  • Prevent githubUsername being a reserved username
  • Support parsing github.io URLs
  • ThanksDev URLs will only be enabled if explicitly set
  • String format now supports parsing and rendering with multiple URLs (now outputting all urlFields) and a description (: description), to expand de-duplication accuracy and offline tooling
  • Renamed getUsernameFromGistUrl to getUsernameFromGitHubGistUrl
  • Years are now combined, supporting when a particular author has paused authorship then resumed later

v7.0.0 2023 December 20

  • Huge improvements to enable backers support in bevry/github
  • Added prefix format option, and corrected description and types for others
  • Now intelligently handles usernames and urls for a number of services
  • Now trims inputs to prevent blank values over-writing non-blank values (opencollective descriptions can be blank)
  • Adding now supports Set type as well
  • Properties related to backers have been renamed
  • Added the toText format
  • Make displayEmail default to enabled on toString as necessary to prevent duplicates
  • Updated dependencies, base files, and editions using boundation

v6.25.0 2023 November 1

v6.24.0 2021 July 30

v6.23.0 2021 July 29

v6.22.0 2021 July 28

v6.21.0 2020 October 29

v6.20.0 2020 September 4

v6.19.0 2020 August 18

v6.18.0 2020 August 4

v6.17.0 2020 July 22

v6.16.0 2020 July 22

v6.15.0 2020 June 25

v6.14.0 2020 June 21

v6.13.0 2020 June 21

v6.12.0 2020 June 20

v6.11.0 2020 June 10

v6.10.0 2020 June 10

v6.9.0 2020 May 22

v6.8.0 2020 May 21

v6.7.0 2020 May 13

v6.6.0 2020 May 8

  • Allow spread to add method
  • New urlFields formatting option for to* methods
  • Updated dependencies, base files, and editions using boundation

v6.5.0 2020 May 4

v6.4.0 2020 March 30

  • Added formatting options
  • Format without email by default, add it back with the displayEmail: true format option

v6.3.0 2020 March 30

  • Do not fail hard on malformed text/string entries

v6.2.0 2020 March 27

  • Added Fellow::years

v6.1.0 2020 March 27

  • Added Fellow::contributions, Fellow::administeredRepositories, Fellow.administersRepository

v6.0.0 2020 March 27

  • Added Fellow.flatten and Fellow.sort, renamed Fellow::compare to Fellow:same and introduced a new Fellow::compare for sorting.

v5.0.0 2020 March 27

  • Rewrote in TypeScript with breaking API changes for simplicity as new native abilities allows us to do more with less

v4.0.0 2020 March 26

  • Updated dependencies, base files, and editions using boundation
  • Minimum required node version changed from node: >=8 to node: >=10 to keep up with mandatory ecosystem changes

v3.3.0 2019 December 9

v3.2.0 2019 December 1

v3.1.0 2019 December 1

v3.0.0 2019 November 18

  • Updated dependencies, base files, and editions using boundation
  • Minimum required node version changed from node: >=0.12 to node: >=8 to keep up with mandatory ecosystem changes

v2.6.0 2019 November 18

v2.5.0 2019 November 13

v2.4.0 2019 January 1

v2.3.0 2016 June 13

  • Fellow homepage will now change https to http to prevent duplicates

v2.2.0 2016 April 30

  • Updated internal conventions

v2.1.0 2015 December 9

  • Updated internal conventions

v2.0.0 2015 September 18

  • Removed years, it was too specific to the bevry/projectz use case
  • Added new compare method
  • Added new json dynamic property
  • Setting an email will now keep an emails array up to date, for multiple email support
  • Renamed setValue to just set
  • ensureFields no longer caches, and now supports array fields

v1.2.0 2015 September 16

  • Added name fallbacks to githubUsername then twitterUsername

v1.1.0 2015 September 16

  • Added repository helpers

v1.0.0 2015 September 16

  • Initial working release