brainbugfix · brainbugfix · commit dcdecf92f042 · 2021-04-03T22:01:14.000+02:00
- updated the typescript
- added a test for writing the comments
diff --git a/index.d.ts b/index.d.ts
@@ -2,6 +2,7 @@ export interface RawImageData<T> {
   width: number;
   height: number;
   data: T;
+  comments?: string[];
 }
 
 type BufferRet = RawImageData<Buffer>;
@@ -10,7 +11,7 @@ type UintArrRet = RawImageData<Uint8Array>;
 type ImageData = BufferRet | UintArrRet;
 type BufferLike = Buffer | Uint8Array | ArrayLike<number> | Iterable<number> | ArrayBuffer;
 
-export declare function encode(imgData: RawImageData<BufferLike>, quality?: number): BufferRet;
+export declare function encode(imgData: RawImageData<BufferLike>, quality?: number): BufferRet & {comments?: string[]};
 
 export declare function decode(
   jpegData: BufferLike,
diff --git a/lib/encoder.js b/lib/encoder.js
@@ -797,7 +797,8 @@ function encode(imgData, qu) {
   return {
     data: data,
     width: imgData.width,
-    height: imgData.height
+    height: imgData.height,
+	comments: imgData.comments
   };
 }
 
diff --git a/test/fixtures/redbox_comment.jpg b/test/fixtures/redbox_comment.jpg
diff --git a/test/index.js b/test/index.js
@@ -179,6 +179,31 @@ it('should be able to create a JPEG from an array', function () {
   expect(jpegImageData.data).toEqual(expected);
 });
 
+it('should be able to create a JPEG from an array with comment', function () {
+  var width = 320,
+    height = 180;
+  var comments = ["First comment", "Second comment"];
+  var frameData = new Buffer(width * height * 4);
+  var i = 0;
+  while (i < frameData.length) {
+    frameData[i++] = 0xff; // red
+    frameData[i++] = 0x00; // green
+    frameData[i++] = 0x00; // blue
+    frameData[i++] = 0xff; // alpha - ignored in JPEGs
+  }
+  var rawImageData = {
+    data: frameData,
+    width: width,
+    height: height,
+    comments: comments,
+  };
+  var jpegImageData = jpeg.encode(rawImageData, 50); 
+  expect(jpegImageData.width).toEqual(width);
+  expect(jpegImageData.height).toEqual(height);
+  var expected = fixture('redbox_comment.jpg');
+  expect(jpegImageData.data).toEqual(expected);
+});
+
 it('should be able to decode a JPEG into a typed array', function () {
   var jpegData = fixture('grumpycat.jpg');
   var rawImageData = jpeg.decode(jpegData, {useTArray: true});

Original file line number	Diff line number	Diff line change
`@@ -797,7 +797,8 @@ function encode(imgData, qu) {`
`797`	`797`	`return {`
`798`	`798`	`data: data,`
`799`	`799`	`width: imgData.width,`
`800`		`- height: imgData.height`
	`800`	`+ height: imgData.height,`
	`801`	`+ comments: imgData.comments`
`801`	`802`	`};`
`802`	`803`	`}`
`803`	`804`