Socket
Socket
Sign inDemoInstall

@woff2/woff2-rs

Package Overview
Dependencies
13
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@woff2/woff2-rs

A WOFF2 decompressor converts WOFF2 to TTF or OTF, powered by Rust based woff2-rs and napi-rs.


Version published
Maintainers
1
Created

Changelog

Source

[1.0.1] - 2023-05-10

fix: missing @woff2/ prefix in the package name in require

Readme

Source

Node woff2-rs

GitHub CI Status @woff2/woff2-rs npm version @woff2/woff2-rs npm downloads

A WOFF2 decompressor converts WOFF2 to TTF or OTF, powered by Rust based woff2-rs and napi-rs.

Features

  • Converts WOFF2 to TTF or OTF.
  • Quick to install, no need for node-gyp and postinstall.
  • Cross-platform support, including Apple M Chips.
  • Support for running as native addons in Deno.

Installation

npm i @woff2/woff2-rs
yarn add @woff2/woff2-rs

Usage

import { promises as fs } from 'fs'
import path, { join } from 'path'
import { fileURLToPath } from 'url'
import woff2Rs from '@woff2/woff2-rs'

const __filename = fileURLToPath(import.meta.url)
const __dirname = path.resolve(path.dirname(__filename))
async function toTTF() {
  const font = await fs.readFile(join(__dirname, '../__test__/fa-regular-400-v5.15.4.woff2'))
  const outputBuffer = woff2Rs.decode(font) // output TTF buffer
  await fs.writeFile(join(__dirname, 'fa-regular-400.ttf'), outputBuffer)
}
toTTF()

Benchmark

npm run bench

Running "WOFF2 to TTF (Use Font Awesome)" suite...
Progress: 50%
Progress: 100%

  woff2-next(node-gyp binding):
    2 990 ops/s, ±0.30%   | fastest

  @napi-rs/ttf2woff2(Rust binding):
    2 396 ops/s, ±0.66%   | 19.87% slower

  @woff2/woff2-rs(Pure Rust):
    1 934 ops/s, ±0.30%   | 35.32% slower

  wawoff(Wasm):
    1 501 ops/s, ±0.75%   | slowest, 49.8% slower

Support matrix

Node.js 12Node.js 14Node.js 16Node.js 18npm
Windows x64npm version
Windows x32npm version
Windows arm64npm version
macOS x64npm version
macOS arm64(M1)npm version
Linux x64 gnunpm version
Linux x64 muslnpm version
Linux arm gnunpm version
Linux arm64 gnunpm version
Linux arm64 muslnpm version
Android arm64npm version
Android armv7npm version

Build

After yarn build/npm run build command, you can see package-template.[darwin|win32|linux].node file in project root. This is the native addon built from lib.rs.

Test

With ava, run yarn test/npm run test to testing native addon. You can also switch to another testing framework if you want.

Develop requirements

  • Install the latest Rust
  • Install Node.js@10+ which fully supported Node-API
  • Install yarn@1.x

Test in local

  • yarn
  • yarn build
  • yarn test

Release package

Ensure you have set your NPM_TOKEN in the GitHub project setting.

In Settings -> Secrets, add NPM_TOKEN into it.

When you want to release the package:

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]

# 1.0.0 => 1.0.1
npm version patch

# or 1.0.0 => 1.1.0
npm version minor

git push

Keywords

FAQs

Last updated on 10 May 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc