@@ -52,8 +39,8 @@
## Install
-```
-$ npm install imagemin
+```sh
+npm install imagemin
```
## Usage
@@ -74,14 +61,14 @@ const files = await imagemin(['images/*.{jpg,png}'], {
});
console.log(files);
-//=> [{data:
, destinationPath: 'build/images/foo.jpg'}, …]
+//=> [{data: , destinationPath: 'build/images/foo.jpg'}, …]
```
## API
### imagemin(input, options?)
-Returns `Promise` in the format `{data: Buffer, sourcePath: string, destinationPath: string}`.
+Returns `Promise` in the format `{data: Uint8Array, sourcePath: string, destinationPath: string}`.
#### input
@@ -103,7 +90,7 @@ Set the destination folder to where your files will be written. If no destinatio
Type: `Array`
-[Plugins](https://www.npmjs.com/browse/keyword/imageminplugin) to use.
+The [plugins](https://www.npmjs.com/browse/keyword/imageminplugin) to use.
##### glob
@@ -112,15 +99,15 @@ Default: `true`
Enable globbing when matching file paths.
-### imagemin.buffer(buffer, options?)
+### imagemin.buffer(data, options?)
-Returns `Promise`.
+Returns `Promise`.
-#### buffer
+#### data
-Type: `Buffer`
+Type: `Uint8Array`
-Buffer to optimize.
+The image data to optimize.
#### options
@@ -135,6 +122,4 @@ Type: `Array`
## Related
- [imagemin-cli](https://github.com/imagemin/imagemin-cli) - CLI for this module
-- [imagemin-app](https://github.com/imagemin/imagemin-app) - GUI app for this module
- [gulp-imagemin](https://github.com/sindresorhus/gulp-imagemin) - Gulp plugin
-- [grunt-contrib-imagemin](https://github.com/gruntjs/grunt-contrib-imagemin) - Grunt plugin
diff --git a/test.js b/test.js
index fbc9c3e..0c3980f 100644
--- a/test.js
+++ b/test.js
@@ -1,13 +1,13 @@
import fs, {promises as fsPromises} from 'node:fs';
import path from 'node:path';
import {fileURLToPath} from 'node:url';
-import del from 'del';
+import {deleteAsync} from 'del';
import imageminJpegtran from 'imagemin-jpegtran';
import imageminWebp from 'imagemin-webp';
import imageminSvgo from 'imagemin-svgo';
-import isJpg from 'is-jpg';
-import tempy from 'tempy';
+import {temporaryDirectory, temporaryFile} from 'tempy';
import test from 'ava';
+import {fileTypeFromBuffer} from 'file-type';
import imagemin from './index.js';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -20,17 +20,22 @@ test('optimize a file', async t => {
t.is(files[0].destinationPath, undefined);
t.true(files[0].data.length < buffer.length);
- t.true(isJpg(files[0].data));
+
+ const fileType = await fileTypeFromBuffer(files[0].data);
+ t.is(fileType?.ext, 'jpg');
});
test('optimize a buffer', async t => {
const buffer = await fsPromises.readFile(path.join(__dirname, 'fixture.jpg'));
+
const data = await imagemin.buffer(buffer, {
plugins: [imageminJpegtran()],
});
t.true(data.length < buffer.length);
- t.true(isJpg(data));
+
+ const fileType = await fileTypeFromBuffer(data);
+ t.is(fileType?.ext, 'jpg');
});
test('output error on corrupt images', async t => {
@@ -40,8 +45,8 @@ test('output error on corrupt images', async t => {
});
test('throw on wrong input', async t => {
- await t.throwsAsync(imagemin('foo'), {message: /Expected an `Array`, got `string`/});
- await t.throwsAsync(imagemin.buffer('foo'), {message: /Expected a `Buffer`, got `string`/});
+ await t.throwsAsync(imagemin('foo'), {message: /Expected argument to be of type `array`/});
+ await t.throwsAsync(imagemin.buffer('foo'), {message: /Expected `Uint8Array`, got `string`/});
});
test('return original file if no plugins are defined', async t => {
@@ -49,16 +54,20 @@ test('return original file if no plugins are defined', async t => {
const files = await imagemin(['fixture.jpg']);
t.is(files[0].destinationPath, undefined);
- t.deepEqual(files[0].data, buffer);
- t.true(isJpg(files[0].data));
+ t.deepEqual(files[0].data, new Uint8Array(buffer));
+
+ const fileType = await fileTypeFromBuffer(files[0].data);
+ t.is(fileType?.ext, 'jpg');
});
test('return original buffer if no plugins are defined', async t => {
const buffer = await fsPromises.readFile(path.join(__dirname, 'fixture.jpg'));
const data = await imagemin.buffer(buffer);
- t.deepEqual(data, buffer);
- t.true(isJpg(data));
+ t.deepEqual(data, new Uint8Array(buffer));
+
+ const fileType = await fileTypeFromBuffer(data);
+ t.is(fileType?.ext, 'jpg');
});
// TODO: Fix the test.
@@ -85,8 +94,8 @@ test.failing('return processed buffer even it is a bad optimization', async t =>
});
test('output at the specified location', async t => {
- const temporary = tempy.directory();
- const destinationTemporary = tempy.directory();
+ const temporary = temporaryDirectory();
+ const destinationTemporary = temporaryDirectory();
const buffer = await fsPromises.readFile(path.join(__dirname, 'fixture.jpg'));
await fsPromises.mkdir(temporary, {recursive: true});
@@ -100,12 +109,12 @@ test('output at the specified location', async t => {
t.true(fs.existsSync(files[0].destinationPath));
t.true(fs.existsSync(files[1].destinationPath));
- await del([temporary, destinationTemporary], {force: true});
+ await deleteAsync([temporary, destinationTemporary], {force: true});
});
test('output at the specified location when input paths contain Windows path delimiter', async t => {
- const temporary = tempy.directory();
- const destinationTemporary = tempy.directory();
+ const temporary = temporaryDirectory();
+ const destinationTemporary = temporaryDirectory();
const buffer = await fsPromises.readFile(path.join(__dirname, 'fixture.jpg'));
await fsPromises.mkdir(temporary, {recursive: true});
@@ -120,34 +129,34 @@ test('output at the specified location when input paths contain Windows path del
t.true(fs.existsSync(files[0].destinationPath));
- await del([temporary, destinationTemporary], {force: true});
+ await deleteAsync([temporary, destinationTemporary], {force: true});
});
test('set webp ext', async t => {
- const temporary = tempy.file();
+ const temporary = temporaryFile();
const files = await imagemin(['fixture.jpg'], {
destination: temporary,
plugins: [imageminWebp()],
});
t.is(path.extname(files[0].destinationPath), '.webp');
- await del(temporary, {force: true});
+ await deleteAsync(temporary, {force: true});
});
test('set svg ext', async t => {
- const temporary = tempy.file();
+ const temporary = temporaryFile();
const files = await imagemin(['fixture.svg'], {
destination: temporary,
plugins: [imageminSvgo()],
});
t.is(path.extname(files[0].destinationPath), '.svg');
- await del(temporary, {force: true});
+ await deleteAsync(temporary, {force: true});
});
test('ignores junk files', async t => {
- const temporary = tempy.directory();
- const destinationTemporary = tempy.directory();
+ const temporary = temporaryDirectory();
+ const destinationTemporary = temporaryDirectory();
const buffer = await fsPromises.readFile(path.join(__dirname, 'fixture.jpg'));
await fsPromises.mkdir(temporary, {recursive: true});
@@ -164,7 +173,7 @@ test('ignores junk files', async t => {
t.false(fs.existsSync(path.join(destinationTemporary, '.DS_Store')));
t.false(fs.existsSync(path.join(destinationTemporary, 'Thumbs.db')));
- await del([temporary, destinationTemporary], {force: true});
+ await deleteAsync([temporary, destinationTemporary], {force: true});
});
test('glob option', async t => {
@@ -173,5 +182,6 @@ test('glob option', async t => {
plugins: [imageminJpegtran()],
});
- t.true(isJpg(files[0].data));
+ const fileType = await fileTypeFromBuffer(files[0].data);
+ t.is(fileType?.ext, 'jpg');
});
-