font-awesome-icons 

> Returns actual list of Font Awesome icons (plain JS array)

Install

``
$ npm install --save font-awesome-icons
`

Usage

`js
const faIcons = require('font-awesome-icons');

faIcons.getList().then(icons => console.log(icons.length));
//=> 675

faIcons.getList().then(icons => console.log(icons[0]));
/*=>
{ name: 'Glass',
id: 'glass',
unicode: 'f000',
created: 1,
filter: [ 'martini', 'drink', 'bar', 'alcohol', 'liquor' ],
categories: [ 'Web Application Icons' ]
}
*/
`

$3

$3

Type: function

Returns a promise with a full list of actual Font Awesome icons.

$3

Type: function

Returns a promise with an actual version of Font Awesome.

$3

Type: function

arrayOfNeededKeys - optional parameter with array of needed keys for icons (eg: ['name', 'unicode'])

Returns a promise with a categories array.

`js
[
{
name: 'Web Application Icons',
icons: [
{
name: 'Glass',
id: 'glass',
unicode: 'f000',
created: 1,
filter: [ 'martini', 'drink', 'bar', 'alcohol', 'liquor' ],
categories: [ 'Web Application Icons' ]
},
...
]
},
...
]
`

$3

Type: function

Returns a promise with array of icons in needed category.

$3

Type: function

Returns a promise with a full list of Font Awesome icons with needed keys only.

`js
const faIcons = require('font-awesome-icons');

faIcons.getListByKeys(['name', 'unicode']).then(icons => console.log(icons[0]));
//=> { name: 'Glass', unicode: 'f000' }
``

Related

font-awesome-v5-icons – separate package for Font Awesome v5

License

MIT © Sergey Lysenko