Skip to content
opencv-wasm

initOpenCV

TypeScript helpershelperOpenCV 5.0.0
import { initOpenCV } from '@banou/opencv-wasm'
ARGUMENTSoptions
HELPERinitOpenCV
RETURN TYPESee signature below
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Initialize the shared OpenCV instance used by named imports such as Mat and GaussianBlur.

export declare const initOpenCV: (options?: OpenCVOptions) => Promise<OpenCV>;
options

WASM asset and logging options. The first successful call configures this instance; later calls reuse it.

Returns

The shared instance, also useful for image helpers and advanced memory access. Concurrent calls share one load; failed loads can be retried.

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.