npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fontscan

v0.3.3

Published

Get font list in specified directory(default system fonts).

Downloads

5

Readme

fontscan

Test

Get font list in specified directory(default system fonts).

This project respect font-manager.

cf.

||fontscan|font-manager| |---|---|---| |native|No, only JS|Yes, made with C| |custom directories|Yes, you can|No, only system fonts| |accuracy|Not good|Good| |speed|Slow|Fast|

more info...

Usage

Get system fonts.

const fontscan = require('fontscan');
console.log(await fontscan.getFontList());

// output
[
  FontDescriptor {
    path: 'C:\\Windows\\Fonts\\AGENCYB.TTF',
    postscriptName: 'AgencyFB-Bold',
    family: 'Agency FB',
    monospace: false,
    width: 3,
    weight: 700,
    italic: false,
    style: 'Bold'
  },
  FontDescriptor {
    path: 'C:\\Windows\\Fonts\\AGENCYR.TTF',
    postscriptName: 'AgencyFB-Reg',
    family: 'Agency FB',
    monospace: false,
    width: 3,
    weight: 400,
    italic: false,
    style: 'Regular'
  },
  ... more items ]

Fonts in specified directory.

Note: We recommend that you do not specify the root directory, as custom directories are searched recursively.

const fonts = await fontscan.getDirectoryFonts('/Library/Fonts');
const fonts = await fontscan.getDirectoriesFonts([
  `C:\\Users\\${username}\\Fonts`,
  `D:\\Fonts`
]);

API

fontscan

fontscan.getFontList(options?): Promise<FontDescriptor[]>

Get fontdescriptors that installed and in specified directories.

  • options
    • customDirectories
      • string[]
      • default: []
    • onlyCustomDirectories
      • boolean
      • default: false

fontscan.getDescriptorFromPaths(fontPaths): Promise<FontDescriptor[]>

Get fontdescriptors that specified files.

  • fontPaths
    • string[]

fontscan.getDirectoryFonts(dirPath): Promise<FontDescriptor[]>

Get fontdescriptors that in specified directory.

  • dirPath
    • string

fontscan.getDirectoriesFonts(dirPaths): Promise<FontDescriptor[]>

Get fontdescriptors that in specified directories.

  • dirPaths
    • string[]

fontscan.getInstalledFonts(): Promise<FontDescriptor[]>

Get fontdescriptors that installed.

FontDescriptor

Font descriptor has basic font informations.

Properties

  • path: string
  • family: string
  • postscriptName: string
  • width: number
  • weight: number
  • style: string
    • e.g. Regular, Bold, Italic, Bold italic
  • italic: boolean
  • monospace: boolean

Contribution

  1. Fork
  2. Create a feature branch
  3. Commit your changes
  4. Rebase your local changes against the master branch
  5. Run test suite with the npm test command and confirm that it passes
  6. Create new Pull Request

Please tell me if my English is wrong

LICENSE

MIT