Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions types/qr-image/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ export type ec_level = "L" | "M" | "Q" | "H";
/** @default 'png' */
export type image_type = "png" | "svg" | "pdf" | "eps";

export type encodable = string | number | Buffer | ReadonlyArray<number>;

export interface Bitmap {
/**
* width (and height) of resulting image in pixels
Expand Down Expand Up @@ -55,13 +57,13 @@ export interface Options {
customize?: ((bitmap: Bitmap) => void) | undefined;
}

export function image(text: string, level?: ec_level): NodeJS.ReadableStream;
export function image(text: string, options?: Options): NodeJS.ReadableStream;
export function image(data: encodable, level?: ec_level): NodeJS.ReadableStream;
export function image(data: encodable, options?: Options): NodeJS.ReadableStream;

export function imageSync(text: string, level?: ec_level): Buffer;
export function imageSync(text: string, options?: Options): string | Buffer;
export function imageSync(data: encodable, level?: ec_level): Buffer;
export function imageSync(data: encodable, options?: Options): string | Buffer;

export function svgObject(text: string, level?: ec_level): SvgObject;
export function svgObject(text: string, options?: Options): SvgObject;
export function svgObject(data: encodable, level?: ec_level): SvgObject;
export function svgObject(data: encodable, options?: Options): SvgObject;

export function matrix(text: string, level?: ec_level): (0 | 1)[][];
export function matrix(data: encodable, level?: ec_level): any[][];
2 changes: 2 additions & 0 deletions types/qr-image/qr-image-tests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ const qr_svg = qr.image("I love QR!", { type: "svg" });
qr_svg.pipe(fs.createWriteStream("i_love_qr.svg"));

const svg_string = qr.imageSync("I love QR!", { type: "svg" });
const svg_string_from_num = qr.imageSync(1234, { type: "svg" });
const svg_string_from_arr = qr.imageSync([1, 128], { type: "svg" });

// customize
function coord2offset(x: number, y: number, size: number) {
Expand Down