Skip to content

Commit 6b42601

Browse files
committed
Provide experimental, automated TypeScript declaration lovell#472
1 parent c6f12fe commit 6b42601

4 files changed

Lines changed: 980 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Any change that modifies the existing public API should be added to the relevant
4343
| ------: | :--------- |
4444
| v0.17.0 | quill |
4545
| v0.18.0 | ridge |
46+
| v0.19.0 | suit |
4647

4748
Please squash your changes into a single commit using a command like `git rebase -i upstream/<wip-branch>`.
4849

@@ -65,13 +66,18 @@ By way of example, the [bilinearInterpolation method](https://github.com/lovell/
6566
## Documentation
6667

6768
The public API is documented with [JSDoc](http://usejsdoc.org/) annotated comments.
68-
These can be converted to Markdown by running:
6969

70+
These can be converted to Markdown by running:
7071
```sh
7172
npm run docs
7273
```
7374

74-
Please include documentation updates in any Pull Request that modifies the public API.
75+
The `types.d.ts` TypeScript declaration can be generated by running:
76+
```sh
77+
npm run types
78+
```
79+
80+
Please include documentation and TypeScript declaration updates in any Pull Request that modifies the public API.
7581

7682
## Run the tests
7783

docs/changelog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ Requires libvips v8.4.2.
1515
Access to these is now via output format functions, for example `quality(n)`
1616
is now `jpeg({quality: n})` and/or `webp({quality: n})`.
1717

18+
* Provide experimental, automated TypeScript declaration.
19+
[#472](https://github.com/lovell/sharp/issues/472)
20+
[@davidreher](https://github.com/davidreher)
21+
1822
* Expose libvips' "centre" resize option to mimic \*magick's +0.5px convention.
1923
[#568](https://github.com/lovell/sharp/issues/568)
2024

0 commit comments

Comments
 (0)