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

authorsGithubRepository

(
  • slug
)
chainable

Defined in esnext/lib/fellow.js:321

Make note that this fellow authors this repository slug

Parameters:

  • slug String

    The github repository slug that this user authors

contributesToGithubRepository

(
  • slug
)
chainable

Defined in esnext/lib/fellow.js:267

Make note that this fellow contributes to this repository slug

Parameters:

  • slug String

    The github repository slug that this user contributes to

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

ensureGithubRepository

(
  • slug
)
Object private

Defined in esnext/lib/fellow.js:238

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

maintainsGithubRepository

(
  • slug
)
chainable

Defined in esnext/lib/fellow.js:294

Make note that this fellow maintains this repository slug

Parameters:

  • slug String

    The github repository slug that this user maintains

Properties

authoredGithubRepositories

Array

Defined in esnext/lib/fellow.js:305

Get all added github repository slugs that this fellow authors

contributedGithubRepositories

Array

Defined in esnext/lib/fellow.js:251

Get all added github repository slugs that this fellow contributes to

email

String

Defined in esnext/lib/fellow.js:139

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:192

Update our fellow with the passed value

githubUrl

String

Defined in esnext/lib/fellow.js:170

githubUsername

String

Defined in esnext/lib/fellow.js:175

homepage

String

Defined in esnext/lib/fellow.js:165

list

Unknown static

Defined in esnext/lib/fellow.js:23

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

maintainedGithubRepositories

Array

Defined in esnext/lib/fellow.js:278

Get all added github repository slugs that this fellow maintains

url

String

Defined in esnext/lib/fellow.js:144

If this is a github URL, then githubUrl and githubUsername are extracted and this is not yet If this is not a github URL, then it is set to homepage When fetched, it will return homepage || githubUrl || null

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

Mixed

Defined in esnext/lib/fellow.js:183

Construct our fellow instance with the value

years

String

Defined in esnext/lib/fellow.js:131

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