API Docs for: 5.0.0
Show:

Fellow Class

Defined in: esnext/lib/fellow.js:1

A fellow with similarties to other people

Constructor

Fellow

()

Defined in esnext/lib/fellow.js:1

Methods

add

(
  • value
)
Array static

Defined in esnext/lib/fellow.js:83

Add a fellow or a series of people, denoted by the value, to the singleton list

Parameters:

  • value Mixed

    The fellow or people to add

Returns:

Array:

An array of the fellow objects for the passed people

authorsRepository

(
  • slug
)
chainable

Defined in esnext/lib/fellow.js:381

Make note that this fellow authors this repository slug

Parameters:

  • slug String

    The github repository slug that this user authors

authorsRepository

(
  • repoSlug
)
Array static

Defined in esnext/lib/fellow.js:138

Get all fellows who author a particular repository

Parameters:

  • repoSlug String

    The repository slug

Returns:

Array:

An array of the fellow objects that author to the repository

contributesRepository

(
  • slug
)
chainable

Defined in esnext/lib/fellow.js:327

Make note that this fellow contributes to this repository slug

Parameters:

  • slug String

    The github repository slug that this user contributes to

contributesRepository

(
  • repoSlug
)
Array static

Defined in esnext/lib/fellow.js:112

Get all fellows who contribute to a particular repository

Parameters:

  • repoSlug String

    The repository slug

Returns:

Array:

An array of the fellow objects that contribute to the repository

create

(
  • value
)
Fellow static

Defined in esnext/lib/fellow.js:12

Create a new Fellow instance with the value, however if the value is already a fellow instance, then just return it

Parameters:

  • value Mixed

Returns:

Fellow:

The new fellow instance

ensure

(
  • value
)
Fellow static

Defined in esnext/lib/fellow.js:45

With the value, see if an existing fellow exists in our singleton list property with the value, otherwise create a new fellow instance with the value and add them to our singleton list

Parameters:

  • value Mixed

    The value to create a new fellow instance or find the existing fellow instance with

Returns:

Fellow:

The new or existing fellow instance

ensureRepository

(
  • slug
)
Object private

Defined in esnext/lib/fellow.js:298

Ensures that the github repository exists on the class

Parameters:

  • slug String

    Github repository slug (e.g. "bevry/projectz")

Returns:

Object:

The repository object

get

(
  • value
)
Fellow | Null static

Defined in esnext/lib/fellow.js:72

Get a fellow from the singleton list

Parameters:

  • value Mixed

    The value to fetch the value with

Returns:

Fellow | Null:

The fetched fellow, if they exist with that value

maintainsRepository

(
  • slug
)
chainable

Defined in esnext/lib/fellow.js:354

Make note that this fellow maintains this repository slug

Parameters:

  • slug String

    The github repository slug that this user maintains

maintainsRepository

(
  • repoSlug
)
Array static

Defined in esnext/lib/fellow.js:125

Get all fellows who maintain a particular repository

Parameters:

  • repoSlug String

    The repository slug

Returns:

Array:

An array of the fellow objects that maintain to the repository

Properties

authoredRepositories

Array

Defined in esnext/lib/fellow.js:365

Get all added github repository slugs that this fellow authors

contributedRepositories

Array

Defined in esnext/lib/fellow.js:311

Get all added github repository slugs that this fellow contributes to

email

String

Defined in esnext/lib/fellow.js:181

ensureFields

Array protected static

Defined in esnext/lib/fellow.js:33

An array of fields that will denote if the user is the same user or not when using ensure

fellow A string in the format of "Benjamin Lupton <b@lupton.cc> (https://balupton.com)" or an object with properties

String | Object

Defined in esnext/lib/fellow.js:249

Update our fellow with the passed value

githubUrl

String

Defined in esnext/lib/fellow.js:227

githubUsername

String

Defined in esnext/lib/fellow.js:232

homepage

String

Defined in esnext/lib/fellow.js:222

list

Unknown static

Defined in esnext/lib/fellow.js:23

A singleton array attached to the class object that stores it's people objects

maintainedRepositories

Array

Defined in esnext/lib/fellow.js:338

Get all added github repository slugs that this fellow maintains

name

String

Defined in esnext/lib/fellow.js:155

If the name is empty, we will try to fallback to githubUsername then twitterUsername If the name is prefixed with a series of numbers, that is considered the year E.g. In 2015+ Bevry Pty Ltd then 2015+ is the years E.g. In 2013-2015 Bevry Pty Ltd then 2013-2015 is the years

url

String

Defined in esnext/lib/fellow.js:186

When set, will determine if it is a github, facebook, or twitter url If it is, then it will extract the username and url from it If this is not one of those urls, then it will set the homepage variable When fetching, it will fetch homepage || githubUrl || facebookUrl || twitterUrl || null

value The value used to set the properties of the fellow, forwarded to setValue

Mixed

Defined in esnext/lib/fellow.js:240

Construct our fellow instance with the value

years

String

Defined in esnext/lib/fellow.js:175

The years that this fellow has