Docs: changelog and help for TypeScript defs #3369 #3370

lovell · Jan 16, 2023 · f79760b · f79760b
1 parent aa5f0f4
commit f79760b
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -19,6 +19,9 @@ Requires libvips v8.14.0
 * Allow use of GPS (IFD3) EXIF metadata.
   [#2767](https://github.com/lovell/sharp/issues/2767)
 
+* TypeScript definitions are now maintained and published directly, deprecating the `@types/sharp` package.
+  [#3369](https://github.com/lovell/sharp/issues/3369)
+
 * Prebuilt binaries: ensure macOS 10.13+ support, as documented.
   [#3438](https://github.com/lovell/sharp/issues/3438)
 

diff --git a/docs/install.md b/docs/install.md
@@ -302,6 +302,17 @@ custom:
         - npm install --arch=x64 --platform=linux sharp
 ```
 
+## TypeScript
+
+TypeScript definitions are published as part of
+the `sharp` package from v0.32.0.
+
+Previously these were available via the `@types/sharp` package,
+which is now deprecated.
+
+When using Typescript, please ensure `devDependencies` includes
+the `@types/node` package.
+
 ## Fonts
 
 When creating text images or rendering SVG images that contain text elements,

diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -1,5 +1,6 @@
 /**
  * Type definitions originally lifted from `@types/sharp`, MIT-licensed.
+ * https://opensource.org/licenses/MIT
  *
  * Original definition authors:
  *  - Wooseop Kim <https://github.com/wooseopkim>

diff --git a/package.json b/package.json
@@ -155,7 +155,7 @@
     "prebuild": "^11.0.4",
     "rimraf": "^3.0.2",
     "semistandard": "^16.0.1",
-    "tsd": "^0.24.1"
+    "tsd": "^0.25.0"
   },
   "license": "Apache-2.0",
   "config": {