mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
34 lines
1.4 KiB
TypeScript
34 lines
1.4 KiB
TypeScript
// Type definitions for qr-image 3.2
|
|
// Project: https://github.com/alexeyten/qr-image
|
|
// Definitions by: taoqf <https://github.com/taoqf>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="node" />
|
|
|
|
/**
|
|
* error correction level. One of L, M, Q, H. Default M.
|
|
*/
|
|
export type ec_level = 'L' | 'M' | 'Q' | 'H';
|
|
|
|
/** @default 'png' */
|
|
export type image_type = 'png' | 'svg' | 'pdf' | 'eps';
|
|
|
|
export interface Options {
|
|
ec_level?: ec_level; // error correction level. One of L, M, Q, H. Default M.
|
|
type?: image_type; // image type. Possible values png(default), svg, pdf and eps.
|
|
size?: number; // (png and svg only) for png and undefined for svg.-(png and svg only) — size of one module in pixels.
|
|
margin?: number; // (only png)for png and 1 for others.-white space around QR image in modules.
|
|
parse_url?: boolean; // (experimental, default false) try to optimize QR-code for URLs.
|
|
}
|
|
|
|
export function image(text: string, level?: ec_level): NodeJS.ReadableStream;
|
|
export function image(text: string, options?: Options): NodeJS.ReadableStream;
|
|
|
|
export function imageSync(text: string, level?: ec_level): Buffer;
|
|
export function imageSync(text: string, options?: Options): string | Buffer;
|
|
|
|
export function svgObject(text: string, level?: ec_level): any;
|
|
export function svgObject(text: string, options?: Options): any;
|
|
|
|
export function matrix(text: string, level?: ec_level): any[][];
|