mirror of
https://github.com/BradNut/awesome-uses
synced 2025-09-08 17:40:31 +00:00
Merge pull request #1343 from BenDMyers/jsdoc
Introduce JSDocs for data.js
This commit is contained in:
commit
0409c95961
1 changed files with 22 additions and 2 deletions
24
src/data.js
24
src/data.js
|
|
@ -1,5 +1,25 @@
|
||||||
// keep it commonjs export
|
/**
|
||||||
// Data is validated against the following schema https://github.com/wesbos/awesome-uses/blob/master/scripts/utils.js#L53-L68
|
* @typedef Person
|
||||||
|
* A single contributor with a /uses page.
|
||||||
|
* Data is validated against the following schema https://github.com/wesbos/awesome-uses/blob/master/scripts/utils.js#L53-L68
|
||||||
|
* @property {string} name - contributor's name
|
||||||
|
* @property {string} description - tagline for contributor
|
||||||
|
* @property {string} url - link to contributor's /uses page
|
||||||
|
* @property {string} country - flag emoji for contributor's country
|
||||||
|
* @property {string} [twitter] - optional Twitter username (beginning with `@`)
|
||||||
|
* @property {string} [emoji] - some emoji corresponding to the contributor
|
||||||
|
* @property {'apple' | 'windows' | 'linux' | 'bsd'} [computer]
|
||||||
|
* @property {'iphone' | 'android' | 'windowsphone' | 'flipphone'} [phone]
|
||||||
|
* @property {string[]} tags - list of tools or other tags the contributor uses
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of all contributors with /uses pages.
|
||||||
|
* @type {Person[]}
|
||||||
|
* Data is validated against the following schema https://github.com/wesbos/awesome-uses/blob/master/scripts/utils.js#L53-L68
|
||||||
|
*
|
||||||
|
* Keep this a commonjs export.
|
||||||
|
*/
|
||||||
module.exports = [
|
module.exports = [
|
||||||
{
|
{
|
||||||
name: 'Ahmed Adebisi',
|
name: 'Ahmed Adebisi',
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue