https://github.com/touchifyapp/wasm-ttf2woff
A WebAssembly module that converts TTF/OTF fonts to WOFF who can run in Browser or in Node.JS
https://github.com/touchifyapp/wasm-ttf2woff
Last synced: 9 months ago
JSON representation
A WebAssembly module that converts TTF/OTF fonts to WOFF who can run in Browser or in Node.JS
- Host: GitHub
- URL: https://github.com/touchifyapp/wasm-ttf2woff
- Owner: touchifyapp
- License: mit
- Created: 2020-11-12T18:37:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-12T19:03:38.000Z (over 5 years ago)
- Last Synced: 2025-09-04T11:46:30.438Z (9 months ago)
- Language: Python
- Size: 343 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# wasm-ttf2woff
[](https://npmjs.org/package/wasm-ttf2woff)
[](https://github.com/touchifyapp/wasm-ttf2woff/actions?query=workflow%3A%22Unit+Tests%22)
[](http://opensource.org/licenses/MIT)
[](https://github.com/semantic-release/semantic-release)
`wasm-ttf2woff` is an utility that converts TTF/OTF fonts to WOFF format.
It is build using WebAssembly so it can run natively in Node.js or in directly in the browser.
It can be very usefull for any webfont generation tools.
WebAssembly also allows code to run much faster that pure javascript implementation.
## Installation
```bash
$ npm install wasm-ttf2woff
```
## Usage
### Node.JS
```typescript
import { ttf2woff } from "wasm-ttf2woff";
import { promises as fs } from "fs";
async function convert(file: string): Promise {
// Read the font
const content = await fs.readFile(file);
// Convert the font to WOFF
const woff = await ttf2woff(content);
// Transform result to Node.JS Buffer
return Buffer.from(woff);
}
```
### Browser
```typescript
import { init, ttf2woff } from "wasm-ttf2woff";
async function convert(blob: Blob): Promise {
// Transforms the Blob to ArrayBuffer
const buffer = await blob.arrayBuffer();
// Transforms the ArrayBuffer to Uint8Array
const content = new Uint8Array(buffer);
// Initialize wasm
await init("path/to/ttf2woff.wasm");
// Convert the font to WOFF
const woff = await ttf2woff(content);
// Creates a new Blob from the result
return new Blob([woff], { type: "font/woff" });
}
```
Note 1: If you do not call `init()` before running `ttf2woff`, the WASM will be loaded assuming that `ttf2woff.wasm` is in the same directory as the current running page.
Note 2: The `init()` function could be called with:
- `string`: the path to the WASM.
- `URL`: the parsed URL to the WASM.
- `Request`: a `fetch` preconfigured Request to the WASM.
- `Response`: a `fetch` Response which contains the WASM.
- `ArrayBuffer`: an ArrayBuffer which contains the WASM.
- `WebAssembly.Module`: the WASM compiled and instantiated.
## Contributing
You are very welcome to contribute to the project. Here are the instructions to build and run the project from source.
### Prerequistes
- [X] [Node.JS](https://nodejs.org/en/download/) 12+
- [X] [Rust](https://www.rust-lang.org/tools/install) 1.47+
- [X] [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
### Steps
```bash
# Clone the project
git clone https://github.com/touchifyapp/wasm-ttf2woff
# Move to the project dir
cd ttf2woff
# Install dependencies
npm ci
# Build the source wasm
npm run build:rust
```
### Common tasks
```bash
# Build the full project
npm run build
# Run unit tests (needs python)
npm test
```
## License
This project is under [MIT](./LICENSE) License. See the LICENSE file for the full license text.