Home

Awesome

os-fonts

Travis Coveralls branch license

Retrieve fonts available on your OS.

Install

$ npm install --save os-fonts

Usage

const osFonts = require('os-fonts');

osFonts.getAll().then(fonts => {
  // array of fonts...
  fonts.forEach(font => {
    console.log(font);
  });
})

API

getAll([useType])

Returns a Promise with all paths to all fonts.

useType

Type: String

Default: system

Options: user, local, network, system

The use type.

getAllSync([useType])

Returns paths to all fonts (synchronous version of getAll).

getFontsInDirectory(dir)

Returns a Promise with paths to all fonts in the given directory.

dir

Type: String

The directory to read

getFontsInDirectory(dir)

Returns paths to all fonts in the given directory (synchronous version of getFontsInDirectory).

License

MIT © Vu Tran