feat: Add strict types and TSDocs to ImageScript.d.ts
#43
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR adds detailed type declarations and TSDoc comments for all exported members, as well as several new `type` and `interface` exports for ease of use.
E.g.:
```ts
export class Image {
// ...
/**
* Encodes the image into a JPEG.
*
* @param quality `1`-`100`, where `1` is lowest quality (highest compression)
* and `100` is highest quality (lowest compression). Default: `90`
*/
async encodeJPEG(quality?: JPEGQuality): Promise<Uint8Array>;
// ...
}
/**
* - `0` = **lowest** quality (smallest file size)
* - `100` = **highest** quality (largest file size)
*/
export type JPEGQuality =
| 1
| 2
| 3
// ...
| 98
| 99
| 100;
```
matmen
added
documentation
matmen
pushed a commit
that referenced
this pull request
Jun 1, 2025
This PR adds detailed type declarations and TSDoc comments for all exported members, as well as several new `type` and `interface` exports for ease of use.
E.g.:
```ts
export class Image {
// ...
/**
* Encodes the image into a JPEG.
*
* @param quality `1`-`100`, where `1` is lowest quality (highest compression)
* and `100` is highest quality (lowest compression). Default: `90`
*/
async encodeJPEG(quality?: JPEGQuality): Promise<Uint8Array>;
// ...
}
/**
* - `0` = **lowest** quality (smallest file size)
* - `100` = **highest** quality (largest file size)
*/
export type JPEGQuality =
| 1
| 2
| 3
// ...
| 98
| 99
| 100;
```
matmen
pushed a commit
that referenced
this pull request
Jun 1, 2025
This PR adds detailed type declarations and TSDoc comments for all exported members, as well as several new `type` and `interface` exports for ease of use.
E.g.:
```ts
export class Image {
// ...
/**
* Encodes the image into a JPEG.
*
* @param quality `1`-`100`, where `1` is lowest quality (highest compression)
* and `100` is highest quality (lowest compression). Default: `90`
*/
async encodeJPEG(quality?: JPEGQuality): Promise<Uint8Array>;
// ...
}
/**
* - `0` = **lowest** quality (smallest file size)
* - `100` = **highest** quality (largest file size)
*/
export type JPEGQuality =
| 1
| 2
| 3
// ...
| 98
| 99
| 100;
```
matmen
pushed a commit
that referenced
this pull request
Jun 1, 2025
This PR adds detailed type declarations and TSDoc comments for all exported members, as well as several new `type` and `interface` exports for ease of use.
E.g.:
```ts
export class Image {
// ...
/**
* Encodes the image into a JPEG.
*
* @param quality `1`-`100`, where `1` is lowest quality (highest compression)
* and `100` is highest quality (lowest compression). Default: `90`
*/
async encodeJPEG(quality?: JPEGQuality): Promise<Uint8Array>;
// ...
}
/**
* - `0` = **lowest** quality (smallest file size)
* - `100` = **highest** quality (largest file size)
*/
export type JPEGQuality =
| 1
| 2
| 3
// ...
| 98
| 99
| 100;
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds detailed type declarations and TSDoc comments for all exported members, including default values.
It also adds several new
typeandinterfaceexports for ease of use.E.g.: