Skip to content

feat(heic-convert): add type definitions for 2.1.0 version #69983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 2 commits into from
Jul 29, 2024
Merged

feat(heic-convert): add type definitions for 2.1.0 version #69983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f301bf
feat(heic-convert): add type definitions for 2.1.0 version
leonardlib Jul 3, 2024
518669f
test: missing tests
leonardlib Jul 25, 2024
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
28 changes: 28 additions & 0 deletions types/heic-convert/browser.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
interface ConversionOptions {
/**
* the HEIC file buffer
*/
buffer: ArrayBufferLike;
/**
* output format
*/
format: "JPEG" | "PNG";
/**
* the JPEG compression quality, between 0 and 1
* @default 0.92
*/
quality?: number;
}

interface Convertible {
convert(): Promise<ArrayBuffer>;
}

/** @async */
declare function convert(image: ConversionOptions): Promise<ArrayBuffer>;
declare namespace convert {
/** @async */
function all(image: ConversionOptions): Promise<Convertible[]>;
}

export = convert;
22 changes: 22 additions & 0 deletions types/heic-convert/heic-convert-tests.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import convert from "heic-convert";
import convertBrowser from "heic-convert/browser";

// $ExpectType Promise<ArrayBuffer>
convert({ buffer: new ArrayBuffer(10), format: "PNG" });
// $ExpectType Promise<ArrayBuffer>
convertBrowser({ buffer: new ArrayBuffer(10), format: "PNG" });

// $ExpectType Promise<ArrayBuffer>
convert({ buffer: new ArrayBuffer(10), format: "JPEG", quality: 0.4 });
// $ExpectType Promise<ArrayBuffer>
convertBrowser({ buffer: new ArrayBuffer(10), format: "JPEG", quality: 0.4 });

// $ExpectType Promise<Convertible[]>
convert.all({ buffer: new ArrayBuffer(10), format: "PNG" });
// $ExpectType Promise<Convertible[]>
convertBrowser.all({ buffer: new ArrayBuffer(10), format: "PNG" });

// $ExpectType Promise<Convertible[]>
convert.all({ buffer: new ArrayBuffer(10), format: "JPEG", quality: 0.4 });
// $ExpectType Promise<Convertible[]>
convertBrowser.all({ buffer: new ArrayBuffer(10), format: "JPEG", quality: 0.4 });
9 changes: 9 additions & 0 deletions types/heic-convert/heic-convert-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
import convert = require("heic-convert");
import convertBrowser = require("heic-convert/browser");

// $ExpectType Promise<ArrayBuffer>
convert({ buffer: new ArrayBuffer(10), format: "PNG" });
// $ExpectType Promise<ArrayBuffer>
convertBrowser({ buffer: new ArrayBuffer(10), format: "PNG" });

// $ExpectType Promise<ArrayBuffer>
convert({ buffer: new ArrayBuffer(10), format: "JPEG", quality: 0.4 });
// $ExpectType Promise<ArrayBuffer>
convertBrowser({ buffer: new ArrayBuffer(10), format: "JPEG", quality: 0.4 });

// $ExpectType Promise<Convertible[]>
convert.all({ buffer: new ArrayBuffer(10), format: "PNG" });
// $ExpectType Promise<Convertible[]>
convertBrowser.all({ buffer: new ArrayBuffer(10), format: "PNG" });

// $ExpectType Promise<Convertible[]>
convert.all({ buffer: new ArrayBuffer(10), format: "JPEG", quality: 0.4 });
// $ExpectType Promise<Convertible[]>
convertBrowser.all({ buffer: new ArrayBuffer(10), format: "JPEG", quality: 0.4 });
8 changes: 6 additions & 2 deletions types/heic-convert/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"private": true,
"name": "@types/heic-convert",
"version": "1.2.9999",
"version": "2.1.9999",
"projects": [
"https://github.com/catdad-experiments/heic-convert"
],
Expand All @@ -13,5 +13,9 @@
"name": "Tregan",
"githubUsername": "treemmett"
}
]
],
"exports": {
".": "./index.d.ts",
"./browser": "./browser.d.ts"
}
}
3 changes: 2 additions & 1 deletion types/heic-convert/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
},
"files": [
"index.d.ts",
"heic-convert-tests.ts"
"heic-convert-tests.ts",
"heic-convert-tests.mts"
]
}