# @mapbox/font-scope

> generate font debugging information

Latest version **1.4.0** (published 2020-03-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install @mapbox/font-scope
pnpm add @mapbox/font-scope
yarn add @mapbox/font-scope
bun add @mapbox/font-scope
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2020-03-03 |
| First published | 2020-03-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 354.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Tom MacWright |
| Maintainers | mapbox-npm-01, mapbox-npm-02, mapbox-npm-07, mapbox-npm-03, mapbox-npm-04, mapbox-npm-09, mapbox-npm-05, mapbox-npm-06, mapbox-npm-08, mapbox-npm-advanced-actions, mapbox-npm-ci, mapbox-npm, mapbox-admin, mapbox-machine-user |

## Links

- npm: https://www.npmjs.com/package/@mapbox/font-scope
- Repository: https://github.com/mapbox/font-scope
- Homepage: https://github.com/mapbox/font-scope#readme
- Issues: https://github.com/mapbox/font-scope/issues
- npm.io page: https://npm.io/package/@mapbox/font-scope

## Dependencies (1)

- [lodash.difference](https://npm.io/package/lodash.difference.md) ^3.0.0

## Recent versions

- 1.4.0 (latest) — 2020-03-03

## README

# font-scope

[![build status](https://secure.travis-ci.org/mapbox/font-scope.png)](http://travis-ci.org/mapbox/font-scope)

generate font debugging information


### `fontScope(points_array)`

Analyze a font's coverage across languages

Analysis results include:

```js
{
  name: 'English',    // English font name
  id: 'en',           // Unicode font code
  coverages: [26, 0], // array of how many codepoints are covered by each points
  count: 26,          // codepoints in this font for this language
  total: 26           // codepoints in this language
}
```


### Parameters

| parameter      | type             | description                                                                        |
| -------------- | ---------------- | ---------------------------------------------------------------------------------- |
| `points_array` | Array\.\<Array\> | an array of arrays of codepoints, corresponding to the coverage of multiple fonts. |



**Returns** `Object`, analysis

## Installation

Requires [nodejs](http://nodejs.org/).

```sh
$ npm install @mapbox/font-scope
```

## Tests

```sh
$ npm test
```

---
_Source: https://npm.io/package/@mapbox/font-scope · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
