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

This commit is contained in:
Lovell Fuller 2023-01-16 11:12:00 +00:00
parent aa5f0f4e40
commit f79760b4f2
4 changed files with 16 additions and 1 deletions

View File

@ -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)

View File

@ -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,

1
lib/index.d.ts vendored
View File

@ -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>

View File

@ -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": {