Skip to content

Commit

Permalink
docs(readme): Add loadBuffer to API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
LabhanshAgrawal committed Mar 9, 2021
1 parent ac31737 commit c49ae2e
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,20 @@ can be used to find ligature information.
within the parser. The size is measured by the length of the input text
for each call. Turned off by default.

### `loadBuffer(buffer, [options])`

Loads the font from it's binary data, returning a [Font](#font) that
can be used to find ligature information.

**Params**

* `buffer` [*ArryaBuffer*] - Binary data of the font file as an ArrayBuffer
* `options` [*object*] - Optional configuration object containing the following
keys:
* `cacheSize` [*number*] - The amount of data from previous results to cache
within the parser. The size is measured by the length of the input text
for each call. Turned off by default.

### Font

Object returned by `load()`. Includes the following methods:
Expand Down

0 comments on commit c49ae2e

Please sign in to comment.