Skip to content
typst-wasm

TypstPluginOptions

Options for the Vite Typst transformation plugin.

Properties

Section titled “Properties”

backend?

Section titled “backend?”

optional backend?: "auto" | "worker" | "jspi"

Backend passed to the compiler.

configureCompiler?

Section titled “configureCompiler?”

optional configureCompiler?: (compiler) => void | Promise<void>

Configures the compiler after it has been created.

Parameters

Section titled “Parameters”
compiler
Section titled “compiler”

TypstCompiler

Returns

Section titled “Returns”

void | Promise<void>

coreModules?

Section titled “coreModules?”

optional coreModules?: Readonly<Record<CoreModuleName, Module | Promise<Module>>>

Precompiled core WASM modules. Defaults to the modules published by typst-wasm.

fetch?

Section titled “fetch?”

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Fetch implementation used for URL and package resources.

Call Signature

Section titled “Call Signature”

(input, init?): Promise<Response>

MDN Reference

Parameters
Section titled “Parameters”
input
Section titled “input”

RequestInfo | URL

init?
Section titled “init?”

RequestInit

Returns
Section titled “Returns”

Promise<Response>

Call Signature

Section titled “Call Signature”

(input, init?): Promise<Response>

MDN Reference

Parameters
Section titled “Parameters”
input
Section titled “input”

string | Request | URL

init?
Section titled “init?”

RequestInit

Returns
Section titled “Returns”

Promise<Response>

fileLoaders?

Section titled “fileLoaders?”

optional fileLoaders?: TypstFileLoader[]

Additional file loaders.

logger?

Section titled “logger?”

optional logger?: TypstLogger

Receives compiler library messages.

logLevel?

Section titled “logLevel?”

optional logLevel?: TypstLogLevel

Controls compiler library messages.

memoryPackageCacheCapacity?

Section titled “memoryPackageCacheCapacity?”

optional memoryPackageCacheCapacity?: number

Capacity of the in-memory package cache.

packageBaseUrl?

Section titled “packageBaseUrl?”

optional packageBaseUrl?: string

Base URL used for Typst package downloads.

packageCache?

Section titled “packageCache?”

optional packageCache?: false | PackageCache

Cache used for downloaded packages, or false to disable caching.

worker?

Section titled “worker?”

optional worker?: () => WorkerHost

Worker factory passed to the compiler.

Returns

Section titled “Returns”

WorkerHost