feat: init

node_modules/uqr/dist/index.d.mts

@@ -0,0 +1,132 @@
+/**
+ * String or binary
+ */
+type QrCodeGenerateData = string | Readonly<Array<number>>;
+interface QrCodeGenerateOptions {
+    /**
+     * Error correction level
+     *
+     * L - Allows recovery of up to 7% data loss
+     * M - Allows recovery of up to 15% data loss
+     * Q - Allows recovery of up to 25% data loss
+     * H - Allows recovery of up to 30% data loss
+     *
+     * @default 'L'
+     */
+    ecc?: 'L' | 'M' | 'Q' | 'H';
+    /**
+     * Mask pattern to use
+     *
+     * @default -1 (auto)
+     */
+    maskPattern?: number;
+    /**
+     * Boost the error correction level to the maximum allowed by the version and size
+     */
+    boostEcc?: boolean;
+    /**
+     * Minimum version of the QR code (1-40)
+     * @default 1
+     */
+    minVersion?: number;
+    /**
+     * Maximum version of the QR code (1-40)
+     * @default 40
+     */
+    maxVersion?: number;
+    /**
+     * Border around the QR code
+     *
+     * @default 1
+     */
+    border?: number;
+    /**
+     * Invert black and white
+     */
+    invert?: boolean;
+    /**
+     * Callback function to receive the generated QR Code
+     */
+    onEncoded?: (qr: QrCodeGenerateResult) => void;
+}
+declare enum QrCodeDataType {
+    Border = -1,
+    Data = 0,
+    Function = 1,
+    Position = 2,
+    Timing = 3,
+    Alignment = 4
+}
+interface QrCodeGenerateResult {
+    /**
+     * QR Code version
+     */
+    version: number;
+    /**
+     * Width and height of the QR Code array
+     */
+    size: number;
+    /**
+     * Mask pattern used
+     */
+    maskPattern: number;
+    /**
+     * Two dimensional array representing the QR Code
+     *
+     * `true` for black, `false` for white
+     */
+    data: boolean[][];
+    /**
+     * Data type of each module
+     */
+    types: QrCodeDataType[][];
+}
+interface QrCodeGenerateInvertableOptions extends QrCodeGenerateOptions {
+    invert?: boolean;
+}
+interface QrCodeGenerateUnicodeOptions extends QrCodeGenerateInvertableOptions {
+    whiteChar?: string;
+    blackChar?: string;
+}
+interface QrCodeGenerateSvgOptions extends QrCodeGenerateOptions {
+    /**
+     * Size of each pixel
+     *
+     * @default 20
+     */
+    pixelSize?: number;
+    /**
+     * Color of the white module
+     *
+     * @default 'white'
+     */
+    whiteColor?: string;
+    /**
+     * Color of the black module
+     *
+     * @default 'black'
+     */
+    blackColor?: string;
+}
+
+declare function encode(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): QrCodeGenerateResult;
+
+/**
+ * Render QR Code with unicode `█`, `░`
+ */
+declare function renderUnicode(data: QrCodeGenerateData, options?: QrCodeGenerateUnicodeOptions): string;
+/**
+ * Render QR Code with ANSI color for terminal
+ */
+declare function renderANSI(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): string;
+/**
+ * Render QR Code with two rows into one line with unicode `▀`, `▄`, `█`, ` `
+ */
+declare function renderUnicodeCompact(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): string;
+
+/**
+ * Render QR Code with ANSI color for terminal
+ */
+declare function renderSVG(data: QrCodeGenerateData, options?: QrCodeGenerateSvgOptions): string;
+
+export { QrCodeDataType, QrCodeGenerateData, QrCodeGenerateInvertableOptions, QrCodeGenerateOptions, QrCodeGenerateResult, QrCodeGenerateSvgOptions, QrCodeGenerateUnicodeOptions, encode, renderANSI, renderSVG, renderUnicode, renderUnicodeCompact };