jimp/types/index.d.ts

An image processing library written entirely in JavaScript (i.e. zero external or native dependencies)

// Minimum TypeScript Version: 3.1

/**
 * While there is nothing in these typings that prevent it from running in TS 2.8 even,
 * due to the complexity of the typings anything lower than TS 3.1 will only see
 * Jimp as `any`. In order to test the strict versions of these types in our typing
 * test suite, the version has been bumped to 3.1
 */

import {
  Jimp as JimpType,
  Bitmap,
  RGB,
  RGBA,
  UnionToIntersection,
  GetPluginVal,
  GetPluginConst,
  GetPluginEncoders,
  GetPluginDecoders,
  JimpConstructors,
} from "@jimp/core";
import typeFn from "@jimp/types";
import pluginFn from "@jimp/plugins";

type Types = ReturnType<typeof typeFn>;
type Plugins = ReturnType<typeof pluginFn>;

type IntersectedPluginTypes = UnionToIntersection<
  GetPluginVal<Types> | GetPluginVal<Plugins>
>;

type IntersectedPluginConsts = UnionToIntersection<
  GetPluginConst<Types> | GetPluginConst<Plugins>
>;

type IntersectedPluginEncoders = UnionToIntersection<
  GetPluginEncoders<Types> | GetPluginEncoders<Plugins>
>;

type IntersectedPluginDecoders = UnionToIntersection<
  GetPluginDecoders<Types> | GetPluginDecoders<Plugins>
>;

type Jimp = JimpType & IntersectedPluginTypes;

declare const Jimp: JimpConstructors &
  IntersectedPluginConsts & {
    prototype: Jimp;
    encoders: IntersectedPluginEncoders;
    decoders: IntersectedPluginDecoders;
  };

export = Jimp;