@forgesworn/qr
Version:
Dependency-free QR code encoder and decoder for TypeScript, browsers, workers and Node, with optional WebAssembly and tracked camera scanning.
19 lines (18 loc) • 784 B
TypeScript
import { type QrCode } from './encode.js';
export interface TerminalOptions {
/** Quiet zone in modules on every side. Default 4, the standard's minimum. */
margin?: number;
/**
* Which modules the block characters draw. `'light'` (the default) suits a
* terminal with a dark background: blocks paint the light modules and the
* quiet zone, and the background shows through as dark modules. Use
* `'dark'` on a light background.
*/
ink?: 'light' | 'dark';
}
/**
* Renders a code as text, two module rows per line with half-block
* characters, one line per row pair and no trailing newline. Needs a
* monospace font whose block characters fill the cell.
*/
export declare function toTerminal(qr: QrCode, options?: TerminalOptions): string;