Skip to main content

registerFont()

Register fonts for @napi-rs/canvas to use (EXTENSION OF GlobalFonts.register())

Parameters​

ParameterTypeRequiredDefaultDescription
pathOrURLstringβœ…The path or URL to the font file.
namestringβœ…The name of the font.
timeoutnumber❌1500Request timeout in milliseconds (IF FONT IS A URL).

Returns​

  • Promise<void>

Throws​

  • XpFatal - If invalid parameters are provided.

[JS] Example​

const {registerFont} = require('simply-xp');
const {Path} = require('path');

await registerFont("https://cdn.jsdelivr.net/fontsource/fonts/mochiy-pop-one@latest/japanese-400-normal.woff2", "MochiyPopOne");

// OR

await registerFont(Path.join(__dirname, "fonts", "MochiyPopOne.ttf"), "MochiyPopOne");