@types/canvas-size

Installation

npm install --save @types/canvas-size

Summary

This package contains type definitions for canvas-size (https://github.com/jhildenbiddle/canvas-size).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/canvas-size.

index.d.ts

// Type definitions for canvas-size 1.2
// Project: https://github.com/jhildenbiddle/canvas-size
// Definitions by: Daniel Kucal <https://github.com/DanielKucal>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

interface CanvasSizeCommonOptions {
    useWorker?: boolean;
    usePromise?: boolean;
    onError?: (width: number, height: number, benchmark: number) => any;
    onSuccess?: (width: number, height: number, benchmark: number) => any;
}

interface CanvasSizeTestOptions extends CanvasSizeCommonOptions {
    width?: number;
    height?: number;
    sizes?: Array<[number, number]>;
}

interface CanvasSizeMaxOptions extends CanvasSizeCommonOptions {
    max?: number;
    min?: number;
    step?: number;
}

interface CanvasSizeMaxReturn {
    width: number;
    height: number;
    benchmark: number;
}

interface CanvasSize {
    test(options: CanvasSizeTestOptions): boolean;

    maxArea(options: CanvasSizeMaxOptions & { usePromise?: false }): void;
    maxArea(options: CanvasSizeMaxOptions & { usePromise: true }): Promise<CanvasSizeMaxReturn>;

    maxWidth(options: CanvasSizeMaxOptions & { usePromise?: false }): void;
    maxWidth(options: CanvasSizeMaxOptions & { usePromise: true }): Promise<CanvasSizeMaxReturn>;

    maxHeight(options: CanvasSizeMaxOptions & { usePromise?: false }): void;
    maxHeight(options: CanvasSizeMaxOptions & { usePromise: true }): Promise<CanvasSizeMaxReturn>;
}

declare const canvasSize: CanvasSize;
export as namespace canvasSize;
export = canvasSize;

Additional Details

• Last updated: Tue, 02 Nov 2021 12:01:24 GMT
• Dependencies: none
• Global values: canvasSize

Credits

These definitions were written by Daniel Kucal.