qr-generate-ts/dist/qr-generator.d.ts

A TypeScript library for generating QR codes with customizable options

import { QROptions, QRResult, SaveOptions } from './types';
/**
 * QR Code Generator class
 */
export declare class QRGenerator {
    private defaultOptions;
    /**
     * Generate QR code as string or Buffer
     * @param text - Text to encode in QR code
     * @param options - Generation options
     * @returns Promise<QRResult>
     */
    generate(text: string, options?: QROptions): Promise<QRResult>;
    /**
     * Generate QR code and save to file
     * @param text - Text to encode in QR code
     * @param options - Save options including file path
     * @returns Promise<QRResult>
     */
    saveToFile(text: string, options: SaveOptions): Promise<QRResult>;
    /**
     * Generate QR code as Data URL (base64)
     * @param text - Text to encode in QR code
     * @param options - Generation options
     * @returns Promise<string>
     */
    toDataURL(text: string, options?: QROptions): Promise<string>;
    /**
     * Generate QR code as SVG string
     * @param text - Text to encode in QR code
     * @param options - Generation options
     * @returns Promise<string>
     */
    toSVG(text: string, options?: QROptions): Promise<string>;
    /**
     * Generate QR code as terminal string
     * @param text - Text to encode in QR code
     * @param options - Generation options
     * @returns Promise<string>
     */
    toTerminal(text: string, options?: QROptions): Promise<string>;
    /**
     * Validate if text can be encoded as QR code
     * @param text - Text to validate
     * @param options - Validation options
     * @returns boolean
     */
    canEncode(text: string, options?: QROptions): boolean;
    /**
     * Get estimated QR code capacity for given options
     * @param options - Options to calculate capacity for
     * @returns Capacity information
     */
    getCapacity(options?: QROptions): {
        numeric: number;
        alphanumeric: number;
        binary: number;
    };
    private mergeOptions;
    private buildQRCodeOptions;
}
export declare const qrGenerator: QRGenerator;
export declare function generateQR(text: string, options?: QROptions): Promise<QRResult>;
export declare function saveQRToFile(text: string, filePath: string, options?: Omit<SaveOptions, 'filePath'>): Promise<QRResult>;
export declare function qrToDataURL(text: string, options?: QROptions): Promise<string>;
export declare function qrToSVG(text: string, options?: QROptions): Promise<string>;
export declare function qrToTerminal(text: string, options?: QROptions): Promise<string>;
//# sourceMappingURL=qr-generator.d.ts.map