ckgl/node_modules/zxing-wasm/dist/cjs/bindings/writerOptions.d.ts
2024-12-21 18:03:43 +08:00

65 lines
1.8 KiB
TypeScript

import { ZXingModule } from "../core.js";
import { WriteInputBarcodeFormat } from "./barcodeFormat.js";
import { CharacterSet } from "./characterSet.js";
import { WriteInputEccLevel } from "./eccLevel.js";
import { ZXingEnum } from "./enum.js";
/**
* @internal
*/
export interface ZXingWriterOptions {
/**
* Width of the barcode.
*
* @defaultValue `200`
*/
width: number;
/**
* Height of the barcode.
*
* @defaultValue `200`
*/
height: number;
format: string;
characterSet: ZXingEnum;
eccLevel: number;
/**
* The minimum number of quiet zone pixels.
*
* @defaultValue `10`
*/
margin: number;
}
/**
* Writer options for writing barcodes.
*/
export interface WriterOptions extends Partial<Omit<ZXingWriterOptions, "format" | "characterSet" | "eccLevel">> {
/**
* The format of the barcode to write.
*
* Supported values are:
* `"Aztec"`, `"Codabar"`, `"Code128"`, `"Code39"`, `"Code93"`,
* `"DataMatrix"`, `"EAN-13"`, `"EAN-8"`, `"ITF"`,
* `"PDF417"`, `"QRCode"`, `"UPC-A"`, `"UPC-E"`
*
* @defaultValue `"QRCode"`
*/
format?: WriteInputBarcodeFormat;
/**
* Character set to use for encoding the text.
* Used for Aztec, PDF417, and QRCode only.
*
* @defaultValue `"UTF8"`
*/
characterSet?: CharacterSet;
/**
* Error correction level of the symbol.
* Used for Aztec, PDF417, and QRCode only.
* `-1` means auto.
*
* @defaultValue `-1`
*/
eccLevel?: WriteInputEccLevel;
}
export declare const defaultWriterOptions: Required<WriterOptions>;
export declare function writerOptionsToZXingWriterOptions<T extends "writer" | "full">(zxingModule: ZXingModule<T>, writerOptions: Required<WriterOptions>): ZXingWriterOptions;