@capsizecss/unpack

Unpack the capsize font metrics directly from a font file.

npm install @capsizecss/unpack

• Usage
  • fromBuffer
  • fromBlob
  • fromUrl
  • fromFile
• Options
  • postscriptName
• Font Metrics

Usage

fromBuffer

Takes a buffer and returns the resolved font metrics.

import { fromBuffer } from '@capsizecss/unpack';

const metrics = await fromBuffer(buffer);

fromBlob

Takes a file blob and returns the resolved font metrics.

import { fromBlob } from '@capsizecss/unpack';

const metrics = await fromBlob(file);

fromUrl

Takes a url string and returns the resolved font metrics.

import { fromUrl } from '@capsizecss/unpack';

const metrics = await fromUrl(url);

fromFile

Takes a file path string and returns the resolved font metrics.

import { fromFile } from '@capsizecss/unpack/fs';

const metrics = await fromFile(filePath);

Options

All of the above APIs accept an optional second parameter with the following options:

postscriptName

Capsize can extract the metrics for a single font from a TrueType Collection (TTC) file by providing the postscriptName.

import { fromFile } from '@capsizecss/unpack';

const metrics = await fromFile('AvenirNext.ttc', {
  postscriptName: 'AvenirNext-Bold',
});

Font metrics

The font metrics object returned contains the following properties:

Thanks

• Devon Govett for creating Fontkit. A fork of Fontkit does all the heavy lifting of extracting the font metrics under the covers.
• SEEK for giving us the space to do interesting work.

License

MIT.