node-fontnik/API.md
Lauren Budorick 5f6f411026 Update API.md
2015-06-08 16:48:47 -07:00

25 lines
721 B
Markdown

## `fontnik`
### `range(options: object, callback: function)`
Get a range of glyphs as a protocol buffer. `options` is an object with options:
* `font: buffer`
* `start: number`
* `end: number`
`font` is the actual font file.
`callback` will be called as `callback(err, res)` where `res` is the protocol buffer result.
### `load(font: buffer, callback: function)`
Read a font's metadata. Returns an object like
``` json
"family_name": "Open Sans",
"style_name": "Regular",
"points": [32,33,34,35…]
```
where `points` is an array of numbers corresponding to unicode points where this font face has coverage.
`callback` will be called as `callback(err, res)` where `res` is an array of font style object metadata.