Installation

npm install --save @types/sharpie

Summary

This package contains type definitions for sharpie (https://github.com/kapouer/sharpie#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sharpie.

index.d.ts

1import { RequestHandler } from "express-serve-static-core";
2import sharpModule = require("sharp");
3
4/**
5 * A simple express middleware for resizing images using sharp and pipes.
6 */
7declare function sharpie(defaults: sharpie.SharpieOptions): RequestHandler;
8
9declare namespace sharpie {
10    interface SharpieOptions {
11        format?: string | undefined;
12        /** @default 'url' */
13        param?: string | undefined;
14        /** @default 90 */
15        q?: number | undefined;
16        /** @default 'w:2048,h:2048,max' */
17        rs?: string | undefined;
18        /** @default false */
19        bg?: string | boolean | undefined;
20        /** @default false */
21        fg?: string | boolean | undefined;
22        /** @default 'center' */
23        crop?: string | undefined;
24        /** @default false */
25        flatten?: boolean | undefined;
26        /** @default false */
27        style?: boolean | undefined;
28        /** @default 'xMinYMin' */
29        ratio?: string | undefined;
30        /** @default undefined */
31        mean?: string | undefined;
32        /**
33         * whitelist hostnames that sharpie can proxy
34         * @default false
35         */
36        hostnames?:
37            | false
38            | string[]
39            | {
40                [hostname: string]: boolean;
41            }
42            | ((hostname: string) => boolean)
43            | undefined;
44        /**
45         * Since version 3.4 it is possible to use imagemagick to convert to ico file format
46         */
47        im?: string | undefined;
48        /**
49         * the sizes of the favicon in ico format, separated by a comma
50         * @default '64,32,16'
51         */
52        sizes?: string | undefined;
53        signs?: {
54            /**  use ~ for better uri-encoding */
55            assignment?: string | undefined;
56            /** use ! for better uri-encoding */
57            separator?: string | undefined;
58        } | undefined;
59    }
60
61    interface SharpieFormats {
62        src: { [format: string]: true };
63        dst: { [format: string]: true };
64    }
65
66    const formats: SharpieFormats;
67    const sharp: typeof sharpModule;
68}
69
70export = sharpie;
71

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: @types/express-serve-static-core, @types/sharp

Credits

These definitions were written by Piotr Błażejewicz.