@qr-platform/qr-code.js/lib/node/index.d.ts

QRCode.js is a professional JavaScript/TypeScript library for creating customized QR codes, offering a blend of simplicity and sophistication. With versatile styling options—dot shapes, colors, gradients, embedded images, borders, and text—it enables you

import { QRCodeJs as _QRCodeJs } from './core/qr-code-js';
import { MethodOverrideOptions, RecursivePartial } from './types/helper';
import { SettingsOptions } from './types/settings-options';
import { StyleOptions } from './types/style-options';
import { TextOptions } from './types/text-options';
import { type Options as _QRCodeJsOptions, type BorderOptions } from './utils/options';
import { ScanValidatorResponse } from './utils/scan-validators/abstract-scan-validator';
export { ErrorCorrectionLevel, Mode, TypeNumber } from './lib/qrcode/QRCodeMinimal';
export { type ExtensionFunction } from './core/qr-code-js';
export { type RecursivePartial } from './types/helper';
export { type CanvasOptions } from './utils/canvas-options';
export { GradientType, type Gradient } from './utils/gradient';
export { type BorderOptions, // Keep exporting the type
CornerDotType, CornerSquareType, DotType, ImageMode, ShapeType } from './utils/options.js';
export type Options = RecursivePartial<_QRCodeJsOptions>;
export type { Options as QRCodeJsOptions };
type QRCodeJsConstructor = new (options: Options, internal?: boolean) => QRCodeJs;
export declare class QRCodeJs extends _QRCodeJs {
    constructor(options: RecursivePartial<_QRCodeJsOptions>, _?: boolean);
    validateScanning(_validatorId?: string, // Default validator
    debug?: boolean): Promise<ScanValidatorResponse>;
    /**
     * Creates a QRCodeBuilder instance initialized with a specific template by its name.
     * Allows for fluent configuration chaining.
     * @param templateName - The user-friendly name of the template to start with.
     * @returns A new QRCodeBuilder instance.
     */
    static useTemplate(templateName: string): QRCodeBuilder;
    /**
     * Creates a QRCodeBuilder instance initialized with a specific template by its ID.
     * Allows for fluent configuration chaining.
     * @param templateId - The ID (original key) of the template to start with.
     * @returns A new QRCodeBuilder instance.
     */
    static useTemplateId(templateId: string): QRCodeBuilder;
    /**
     * Creates a QRCodeBuilder instance initialized with a specific style.
     * Allows for fluent configuration chaining.
     * @param styleNameOrOptions - The name of the predefined style or a StyleOptions object.
     * @returns A new QRCodeBuilder instance.
     */
    static useStyle(styleNameOrOptions: string | StyleOptions): QRCodeBuilder;
    /**
     * Creates a QRCodeBuilder instance initialized with a specific style by its ID.
     * Allows for fluent configuration chaining.
     * @param styleId - The ID of the predefined style.
     * @returns A new QRCodeBuilder instance.
     */
    static useStyleId(styleId: string): QRCodeBuilder;
    /**
     * Creates a QRCodeBuilder instance initialized with specific border options.
     * Allows for fluent configuration chaining.
     * @param borderNameOrOptions - The name of the predefined border or a BorderOptions object.
     * @returns A new QRCodeBuilder instance.
     */
    static useBorder(borderNameOrOptions: string | BorderOptions): QRCodeBuilder;
    /**
     * Creates a QRCodeBuilder instance initialized with a specific border by its ID.
     * Allows for fluent configuration chaining.
     * @param borderId - The ID of the predefined border.
     * @returns A new QRCodeBuilder instance.
     */
    static useBorderId(borderId: string): QRCodeBuilder;
    /**
     * Creates a QRCodeBuilder instance initialized with a specific image.
     * Allows for fluent configuration chaining.
     * @param imageUrl - The URL or data URL of the image to use.
     * @returns A new QRCodeBuilder instance.
     */
    static useImage(imageUrl: string, overrideOpts?: MethodOverrideOptions): QRCodeBuilder;
    /**
     * Creates a QRCodeBuilder instance initialized with specific text options.
     * Allows for fluent configuration chaining.
     * @param textNameOrOptions - The name of the predefined text template or a TextOptions object.
     * @returns A new QRCodeBuilder instance.
     */
    static useText(textNameOrOptions: string | TextOptions, overrideOpts?: MethodOverrideOptions): QRCodeBuilder;
    /**
     * Creates a QRCodeBuilder instance initialized with a specific text template by its ID.
     * Allows for fluent configuration chaining.
     * @param textId - The ID of the predefined text template.
     * @returns A new QRCodeBuilder instance.
     */
    static useTextId(textId: string, overrideOpts?: MethodOverrideOptions): QRCodeBuilder;
    static useData(data: string, overrideOpts?: MethodOverrideOptions): QRCodeBuilder;
    static useOptions(options: RecursivePartial<Options>, // Changed from Options to RecursivePartial<Options>
    overrideOpts?: MethodOverrideOptions): QRCodeBuilder;
    static useSettings(settings: SettingsOptions): QRCodeBuilder;
}
export declare class _ extends QRCodeJs {
    constructor(options: Options);
}
export declare class QRCodeBuilder {
    private _qrCodeConstructor;
    protected _templateSource: string | RecursivePartial<Options> | null;
    protected _borderSource: string | BorderOptions | null;
    protected _styleSource: string | StyleOptions | null;
    protected _imageSource: string | null;
    protected _imageOverride: boolean;
    protected _textSource: string | TextOptions | null;
    protected _textOverride: boolean;
    protected _isTemplateById: boolean;
    protected _isBorderById: boolean;
    protected _isStyleById: boolean;
    protected _isTextById: boolean;
    protected _optionsSource: RecursivePartial<Options> | null;
    protected _optionsOverride: boolean;
    protected _dataSource: string | null;
    protected _dataOverride: boolean;
    protected _idSource: string | null;
    protected _nameSource: string | null;
    protected _descriptionSource: string | null;
    protected _metadataSource: Record<string, any> | null;
    protected _initialOptions: RecursivePartial<Options> | null;
    constructor(qrCodeConstructor: QRCodeJsConstructor, templateNameOrOptions?: string | RecursivePartial<Options>);
    useTemplate(templateName: string): this;
    useTemplateId(templateId: string): this;
    useStyle(styleNameOrOptions: string | StyleOptions): this;
    useStyleId(styleId: string): this;
    useBorder(borderNameOrOptions: string | BorderOptions): this;
    useBorderId(borderId: string): this;
    useImage(imageUrl: string, overrideOpts?: MethodOverrideOptions): this;
    useData(data: string, overrideOpts?: MethodOverrideOptions): this;
    useText(textNameOrOptions: string | TextOptions, overrideOpts?: MethodOverrideOptions): this;
    useTextId(textId: string, overrideOpts?: MethodOverrideOptions): this;
    useOptions(options: RecursivePartial<Options>, overrideOpts?: MethodOverrideOptions): this;
    useId(id: string): this;
    useName(name: string): this;
    useDescription(description: string): this;
    useMetadata(metadata: Record<string, any>): this;
    useSettings(settings: SettingsOptions): this;
    private _resolveAndMergeConfig;
    options(options: RecursivePartial<Options>): QRCodeJs;
    build(): QRCodeJs;
}