Skip to content

Commit fcf2f9b

Browse files
authored
chore: update dependencies and links (#136)
1 parent bb9148e commit fcf2f9b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+630
-630
lines changed

.github/workflows/nodejs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ jobs:
1010
nodejs:
1111
uses: zakodium/workflows/.github/workflows/nodejs.yml@nodejs-v1
1212
with:
13-
node-version: 22.x
13+
node-version: 24.x
1414
lint-check-types: true
1515
npm-test-command: npm run build
16-
node-version-matrix: '[22]'
16+
node-version-matrix: '[24]'
1717
upload-coverage: false
1818
disable-test-package: true

.github/workflows/spellcheck.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
spellcheck:
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/checkout@v4
13+
- uses: actions/checkout@v5
1414
- uses: streetsidesoftware/cspell-action@v7
1515
with:
1616
config: ./cspell.config.yaml

.node-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
22
1+
24

.npmrc

Lines changed: 0 additions & 1 deletion
This file was deleted.

.nvmrc

Lines changed: 0 additions & 1 deletion
This file was deleted.
File renamed without changes.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# image-js-docs
22

3-
This is the source code repository for the documentation of [image-js](https://github.com/image-js/image-js-typescript)
3+
This is the source code repository for the documentation of [image-js](https://github.com/image-js/image-js)
44

5-
The documentation is available on [https://image-js-docs.pages.dev/](https://image-js-docs.pages.dev/)
5+
The documentation is available on <https://docs.image-js.org/>.
66

77
## Create demos
88

9-
A demo is simply function which takes an image or mask as input and returns an image or mask as output. When imported in `md` files, it will be transformed into a demo component which allows to choose from various image or video sources to showcase the image transformation.
9+
A demo is simply a function which takes an image or mask as input and returns an image or mask as output. When imported in `md` files, it will be transformed into a demo component which allows choosing from various image or video sources to showcase the image transformation.
1010

1111
### Image example
1212

blog/release.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ title: Release notes v1
44
date: 2025-07-25
55
---
66

7-
We're excited to announce the release of a new major version of ImageJS. This version brings TypeScript support and a more intuitive API while maintaining the powerful image processing capabilities you love.
7+
We're excited to announce the release of a new major version of ImageJS.
8+
This version brings TypeScript support and a more intuitive API while maintaining the powerful image processing capabilities you love.
89

910
<!-- truncate -->
1011

@@ -22,7 +23,8 @@ const pixel = img.getPixel(x, y); // any[]
2223
const pixel = img.getPixel(x, y); // number[] with proper channel count
2324
```
2425

25-
This helps preventing runtime type errors and enables better IntelliSense, autocomplete, and refactoring support in your IDE. Developers can now catch bugs at compile time rather than discovering them in production.
26+
This helps prevent runtime type errors and enables better IntelliSense, autocomplete, and refactoring support in your IDE.
27+
Developers can now catch bugs at compile time rather than discovering them in production.
2628

2729
## ⚠️ Breaking changes
2830

@@ -54,11 +56,11 @@ const img = readSync('cat.jpg');
5456
writeSync('newCat.jpg', img);
5557
```
5658

57-
Those changes separates I/O operations from image manipulation for a clearer API design.
59+
Those changes separate I/O operations from image manipulation for a clearer API design.
5860

5961
#### Creating images
6062

61-
When creating a new image, unlike before, image's width and height must be specified.
63+
When creating a new image, unlike before, the image's width and height must be specified.
6264

6365
```ts
6466
import { Image } from 'image-js';
@@ -78,8 +80,8 @@ Coordinates are now represented using `Point` objects instead of arrays. This ch
7880
```ts
7981
// Before
8082
const croppedImage = img.crop({
81-
x:10,
82-
y:10
83+
x: 10,
84+
y: 10,
8385
width: 10,
8486
height: 10,
8587
});
@@ -91,7 +93,7 @@ const croppedImage = img.crop({
9193
});
9294
```
9395

94-
It is a more explicit and self-documenting code. It also eliminates confusion about array order (column vs row).
96+
It is a more explicit and self-documenting code. It also removes confusion about array order (column vs row).
9597

9698
### Masks
9799

@@ -146,7 +148,7 @@ const whiteRegions = roiMap.whiteRois;
146148

147149
The new `blackRois` and `whiteRois` properties provide more intuitive access to region data based on pixel values rather than geometric dimensions.
148150

149-
For more information, please, visit these tutorials:
151+
For more information, please visit these tutorials:
150152

151153
- [Image segmentation with `threshold()` and `fromMask()`](../docs/Tutorials/Image%20segmentation%20with%20threshold)
152154
- [Image segmentation with `watershed()`](../docs/Tutorials/Image%20segmentation%20with%20watershed)
@@ -263,21 +265,21 @@ The following deprecated features have been removed:
263265

264266
#### Images
265267

266-
- `countAlphaPixel()` - Use custom pixel counting with [`getPixel()`](https://image-js.github.io/image-js/classes/index.Image.html#getpixel 'API link on getPixel').
268+
- `countAlphaPixel()` - Use custom pixel counting with [`getPixel()`](https://api.image-js.org/classes/index.Image.html#getpixel 'API link on getPixel').
267269
- `paintLabels()` and `roi.paint()` - Features have been removed due to dependency issues. We plan to add it back in future updates.
268270
- `warpingFourPoints()` - Use [`getPerspectiveWarpMatrix()`](../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on getPerspectiveWarp') + [`transform()`](release.md#transform) instead.
269271
- 32-bit color depth support and `abs()` have been removed.
270272
- `CMYK` and `HSL` color models have been removed.
271-
- `paintMasks()` has been removed. Use [`paintMask()`](https://image-js.github.io/image-js/classes/index.Image.html#paintmask 'API link on paintMask')+ a `for` loop.
273+
- `paintMasks()` has been removed. Use [`paintMask()`](https://api.image-js.org/classes/index.Image.html#paintmask 'API link on paintMask')+ a `for` loop.
272274
- `clearBit()` and `toggleBit()` have been removed, due to changes in `Mask`
273-
data representation (see ["Masks"](#masks)). Use [`setBit()`](https://image-js.github.io/image-js/classes/index.Mask.html#setbit 'API link on setBit') or [`setValue()`](https://image-js.github.io/image-js/classes/index.Image.html#setvalue 'API link on setValue') instead.
275+
data representation (see ["Masks"](#masks)). Use [`setBit()`](https://api.image-js.org/classes/index.Mask.html#setbit 'API link on setBit') or [`setValue()`](https://api.image-js.org/classes/index.Image.html#setvalue 'API link on setValue') instead.
274276
- `combineChannels()` has been removed.
275-
- `rgba8()` and `rgba()` have been removed. Use a combination of [`convertColor()`](https://image-js.github.io/image-js/classes/index.Image.html#convertcolor 'API link on convertColor') and [`convertBitDepth()`](https://image-js.github.io/image-js/classes/index.Image.html#convertbitdepth 'API link on convertBitDepth') instead.
277+
- `rgba8()` and `rgba()` have been removed. Use a combination of [`convertColor()`](https://api.image-js.org/classes/index.Image.html#convertcolor 'API link on convertColor') and [`convertBitDepth()`](https://api.image-js.org/classes/index.Image.html#convertbitdepth 'API link on convertBitDepth') instead.
276278
- `histograms()` and `colorHistogram()` have been removed.
277279
- `getPixelGrid()` has been removed.
278280
- `getClosestCommonParent()` and `getRelativePosition()` have been removed.
279281
- `getSimilarity()` and `getIntersection()` have been removed.
280-
- `paintPolygons()` and `paintPolylines()`have been removed. Use [`drawPolygon()`](https://image-js.github.io/image-js/classes/index.Image.html#drawpolygon 'API link on drawPolygon')/ [`drawPolyline()`](https://image-js.github.io/image-js/classes/index.Image.html#drawpolyline 'API link on drawPolyline') + a `for` loop.
282+
- `paintPolygons()` and `paintPolylines()`have been removed. Use [`drawPolygon()`](https://api.image-js.org/classes/index.Image.html#drawpolygon 'API link on drawPolygon')/ [`drawPolyline()`](https://api.image-js.org/classes/index.Image.html#drawpolyline 'API link on drawPolyline') + a `for` loop.
281283
- `getMoment()` has been removed.
282284

283285
#### ROIs and its management
@@ -289,7 +291,7 @@ The following deprecated features have been removed:
289291
- `findCorrespondingRoi()` has been removed.
290292
- `resetPainted()` has been removed.
291293
- `mergeRoi()` and `mergeRois()` have been removed.
292-
- `minX`,`minY`,`meanX`,`meanY`,`maxX`,`maxY` have been removed. Use [ROI's `origin`, combined with its `width` and `height`](https://image-js.github.io/image-js/classes/index.Roi.html 'API link on ROI').
294+
- `minX`,`minY`,`meanX`,`meanY`,`maxX`,`maxY` have been removed. Use [ROI's `origin`, combined with its `width` and `height`](https://api.image-js.org/classes/index.Roi.html 'API link on ROI').
293295

294296
## 🆕 New features
295297

@@ -374,7 +376,7 @@ const corrected = image.correctColor(measured, reference);
374376

375377
### `variance()`
376378

377-
A function that calculates image's [variance](https://en.wikipedia.org/wiki/Variance 'wikipedia link on variance') has been added.
379+
A function that calculates an image's [variance](https://en.wikipedia.org/wiki/Variance 'wikipedia link on variance') has been added.
378380

379381
```ts
380382
// Calculate variance for entire image
@@ -412,7 +414,7 @@ const pixelatedImage = image.pixelate({
412414

413415
### `cropRectangle()`
414416

415-
While `crop()` and `cropRectangle()` might appear similar. However, they provide provide different approaches to extracting image regions.
417+
While `crop()` and `cropRectangle()` might appear similar. However, they provide different approaches to extracting image regions.
416418

417419
`crop()` - Standard rectangular cropping that maintains the original image orientation:
418420

@@ -585,14 +587,14 @@ Bugs in multiple functions have been fixed:
585587

586588
## 📚 Resources
587589

588-
- [API Documentation](https://image-js.github.io/image-js-typescript/ 'link on API')
589-
- [Examples and Tutorials](https://image-js-docs.pages.dev/ 'link on image-js tutorials and tips')
590+
- [API Documentation](https://api.image-js.org/ 'link on API')
591+
- [Examples and Tutorials](https://docs.image-js.org/ 'link on image-js tutorials and tips')
590592

591593
## 🤝 Contributing
592594

593595
We welcome contributions! The new TypeScript codebase makes it easier than ever to contribute.
594596

595-
- [GitHub Repository](https://github.com/image-js/image-js-typescript 'link on github repository')
597+
- [GitHub Repository](https://github.com/image-js/image-js 'link on github repository')
596598

597599
## 🙏 Acknowledgments
598600

cspell.config.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
3-
version: '0.2'
43
dictionaryDefinitions:
54
- name: project-words
65
path: './project-words.txt'

docs/Basics/Working with Masks.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ const mask = new Mask(500, 500); // Creates a simple mask filled with 0s of size
1616

1717
#### Options
1818

19-
| Property | Required | Default value |
20-
| --------------------------------------------------------------------------------------------- | -------- | ---------------------- |
21-
| [`origin`](https://image-js.github.io/image-js-typescript/interfaces/MaskOptions.html#origin) | no | `{row: 0, column: 0 }` |
22-
| [`data`](https://image-js.github.io/image-js-typescript/interfaces/MaskOptions.html#data) | no | - |
19+
| Property | Required | Default value |
20+
| ----------------------------------------------------------------------------- | -------- | ---------------------- |
21+
| [`origin`](https://api.image-js.org/interfaces/index.MaskOptions.html#origin) | no | `{row: 0, column: 0 }` |
22+
| [`data`](https://api.image-js.org/interfaces/index.MaskOptions.html#data) | no | - |
2323

2424
### Use `threshold()` method
2525

0 commit comments

Comments
 (0)