Skip to content

princjef/get-system-fonts

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

get-system-fonts

Travis CI build status codecov npm version

List full paths to all of the system fonts present.

npm install get-system-fonts

Usage

const getSystemFonts = require('get-system-fonts');

// In an async function...
const files = await getSystemFonts(); // ['/Library/Fonts/Georgia.ttf', ...]

API

getSystemFonts([options]): Promise<string[]>

Lists absolute paths to all system fonts

NOTE: If you're using Typescript, getSystemFonts() is available as the default export.

Params

  • options [object] - Options for configuring retrieval
    • additionalFolders [string[]] - Paths to additional folders to recursively scan for font files. Absolute paths are recommended. Default: []
    • extensions [string[]] - List of file extensions to treat as font files. Default: ['ttf', 'otf', 'ttc', 'woff', 'woff2']

Contributing

Want to contribute to the project? Go check out the Contribution Guide for instructions to set up your development environment, open an issue and create a pull request.

About

List full paths to all system fonts

Resources

License

Stars

Watchers

Forks

Packages

No packages published