sharp-phash icon indicating copy to clipboard operation
sharp-phash copied to clipboard

add types declaration file for TS support

Open andersonjoseph opened this issue 2 years ago • 2 comments

closes #14

andersonjoseph avatar Aug 03 '23 23:08 andersonjoseph

Thanks for this PR @andersonjoseph! @btd WDYT?

kachkaev avatar Aug 25 '23 17:08 kachkaev

In the meantime, I am using declarations/sharp-phash.d.ts as a workaround:

declare module "sharp-phash" {
  import type sharp from "sharp";

  type SharpImage = Parameters<typeof sharp>[0];
  type SharpOptions = Parameters<typeof sharp>[1];

  export default function phash(
    image: SharpImage,
    options?: SharpOptions,
  ): Promise<string>;
}

declare module "sharp-phash/distance" {
  export default function distance(a: string, b: string): number;
}

Thanks for crafting the diff @andersonjoseph 🙌

kachkaev avatar Oct 19 '23 20:10 kachkaev