@thi.ng/pixel-io-netpbm 2.1.6 → 2.1.9

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-12-13T10:26:00Z
+- **Last updated**: 2022-04-07T14:17:30Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [2.1.9](https://github.com/thi-ng/umbrella/tree/@thi.ng/pixel-io-netpbm@2.1.9) (2022-04-07)
+
+#### ♻️ Refactoring
+
+- replace deprecated .substr() w/ .substring() ([0710509](https://github.com/thi-ng/umbrella/commit/0710509))
+
 ## [2.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/pixel-io-netpbm@2.1.0) (2021-11-17)
 
 #### 🚀 Features

package/README.md

@@ -149,4 +149,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2021 Karsten Schmidt // Apache Software License 2.0
+© 2021 - 2022 Karsten Schmidt // Apache Software License 2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/pixel-io-netpbm",
-  "version": "2.1.6",
+  "version": "2.1.9",
   "description": "Multi-format NetPBM reader & writer support for @thi.ng/pixel",
   "type": "module",
   "module": "./index.js",
@@ -34,17 +34,17 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.3",
-    "@thi.ng/errors": "^2.1.3",
-    "@thi.ng/pixel": "^3.3.0"
+    "@thi.ng/api": "^8.3.5",
+    "@thi.ng/errors": "^2.1.5",
+    "@thi.ng/pixel": "^3.4.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.19.2",
-    "@thi.ng/testament": "^0.2.3",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.5",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.10",
-    "typescript": "^4.5.3"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "1bit",
@@ -73,18 +73,18 @@
   ],
   "exports": {
     ".": {
-      "import": "./index.js"
+      "default": "./index.js"
     },
     "./read": {
-      "import": "./read.js"
+      "default": "./read.js"
     },
     "./write": {
-      "import": "./write.js"
+      "default": "./write.js"
     }
   },
   "thi.ng": {
     "parent": "@thi.ng/pixel",
     "year": 2021
   },
-  "gitHead": "2db9dd34c0c2c60cbfde3dad0bca352b20292f5c\n"
+  "gitHead": "5ee1feb590dd935593b1dd4e7f38a3ed3ba64765\n"
 }

package/read.d.ts

@@ -1,7 +1,7 @@
 /**
  * Parses header information from given NetPBM file byte buffer.
  *
- * @param src
+ * @param src -
  */
 export declare const parseHeader: (src: Uint8Array) => {
     type: string;
@@ -26,7 +26,7 @@ export declare const parseHeader: (src: Uint8Array) => {
  * Function will throw an error if image is of any other type or header is
  * corrupt otherwise. Any embedded comments will be discarded.
  *
- * @param src
+ * @param src -
  */
 export declare const read: (src: Uint8Array) => import("@thi.ng/pixel/int").IntBuffer;
 /**
@@ -34,10 +34,10 @@ export declare const read: (src: Uint8Array) => import("@thi.ng/pixel/int").IntB
  * returns {@link @thi.ng/pixel#IntBuffer} in `GRAY8` format (due to current
  * lack of true 1bit format).
  *
- * @param src
- * @param i
- * @param width
- * @param height
+ * @param src -
+ * @param i -
+ * @param width -
+ * @param height -
  */
 export declare const readPBM: (src: Uint8Array, i: number, width: number, height: number) => import("@thi.ng/pixel/int").IntBuffer;
 /**
@@ -49,11 +49,11 @@ export declare const readPBM: (src: Uint8Array, i: number, width: number, height
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pbm.html
  *
- * @param src
- * @param i
- * @param width
- * @param height
- * @param max
+ * @param src -
+ * @param i -
+ * @param width -
+ * @param height -
+ * @param max -
  */
 export declare const readPGM8: (src: Uint8Array, i: number, width: number, height: number, max?: number) => import("@thi.ng/pixel/int").IntBuffer;
 /**
@@ -64,11 +64,11 @@ export declare const readPGM8: (src: Uint8Array, i: number, width: number, heigh
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pgm.html
  *
- * @param src
- * @param i
- * @param width
- * @param height
- * @param max
+ * @param src -
+ * @param i -
+ * @param width -
+ * @param height -
+ * @param max -
  */
 export declare const readPGM16: (src: Uint8Array, i: number, width: number, height: number, max?: number) => import("@thi.ng/pixel/int").IntBuffer;
 /**
@@ -80,11 +80,11 @@ export declare const readPGM16: (src: Uint8Array, i: number, width: number, heig
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pgm.html
  *
- * @param src
- * @param i
- * @param width
- * @param height
- * @param max
+ * @param src -
+ * @param i -
+ * @param width -
+ * @param height -
+ * @param max -
  */
 export declare const readPPM: (src: Uint8Array, i: number, width: number, height: number, max?: number) => import("@thi.ng/pixel/int").IntBuffer;
 //# sourceMappingURL=read.d.ts.map

package/read.js

@@ -23,7 +23,7 @@ const readComments = (src, acc, i) => {
         // @ts-ignore
         const [comment, j] = readUntil(src, i);
         assert(j !== i, `EOF reached`);
-        acc.push(comment.substr(1).trim());
+        acc.push(comment.substring(1).trim());
         i = j;
     }
     return i;
@@ -31,7 +31,7 @@ const readComments = (src, acc, i) => {
 /**
  * Parses header information from given NetPBM file byte buffer.
  *
- * @param src
+ * @param src -
  */
 export const parseHeader = (src) => {
     let type;
@@ -75,7 +75,7 @@ export const parseHeader = (src) => {
  * Function will throw an error if image is of any other type or header is
  * corrupt otherwise. Any embedded comments will be discarded.
  *
- * @param src
+ * @param src -
  */
 export const read = (src) => {
     const { type, width, height, max, start } = parseHeader(src);
@@ -97,10 +97,10 @@ export const read = (src) => {
  * returns {@link @thi.ng/pixel#IntBuffer} in `GRAY8` format (due to current
  * lack of true 1bit format).
  *
- * @param src
- * @param i
- * @param width
- * @param height
+ * @param src -
+ * @param i -
+ * @param width -
+ * @param height -
  */
 export const readPBM = (src, i, width, height) => {
     const buf = intBuffer(width, height, GRAY8);
@@ -124,11 +124,11 @@ export const readPBM = (src, i, width, height) => {
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pbm.html
  *
- * @param src
- * @param i
- * @param width
- * @param height
- * @param max
+ * @param src -
+ * @param i -
+ * @param width -
+ * @param height -
+ * @param max -
  */
 export const readPGM8 = (src, i, width, height, max = 0xff) => {
     const buf = intBuffer(width, height, GRAY8);
@@ -152,11 +152,11 @@ export const readPGM8 = (src, i, width, height, max = 0xff) => {
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pgm.html
  *
- * @param src
- * @param i
- * @param width
- * @param height
- * @param max
+ * @param src -
+ * @param i -
+ * @param width -
+ * @param height -
+ * @param max -
  */
 export const readPGM16 = (src, i, width, height, max = 0xffff) => {
     const buf = intBuffer(width, height, GRAY16);
@@ -176,11 +176,11 @@ export const readPGM16 = (src, i, width, height, max = 0xffff) => {
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pgm.html
  *
- * @param src
- * @param i
- * @param width
- * @param height
- * @param max
+ * @param src -
+ * @param i -
+ * @param width -
+ * @param height -
+ * @param max -
  */
 export const readPPM = (src, i, width, height, max = 0xff) => {
     const buf = intBuffer(width, height, RGB888);

package/write.d.ts

@@ -5,8 +5,8 @@ import type { IntBuffer } from "@thi.ng/pixel";
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pbm.html
  *
- * @param buf
- * @param comments
+ * @param buf -
+ * @param comments -
  */
 export declare const asPBM: (buf: IntBuffer, comments?: string[] | undefined) => Uint8Array;
 /**
@@ -16,8 +16,8 @@ export declare const asPBM: (buf: IntBuffer, comments?: string[] | undefined) =>
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pgm.html
  *
- * @param buf
- * @param comments
+ * @param buf -
+ * @param comments -
  */
 export declare const asPGM: (buf: IntBuffer, comments?: string[] | undefined) => Uint8Array;
 /**
@@ -27,8 +27,8 @@ export declare const asPGM: (buf: IntBuffer, comments?: string[] | undefined) =>
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pgm.html
  *
- * @param buf
- * @param comments
+ * @param buf -
+ * @param comments -
  */
 export declare const asPGM16: (buf: IntBuffer, comments?: string[] | undefined) => Uint8Array;
 /**
@@ -37,8 +37,8 @@ export declare const asPGM16: (buf: IntBuffer, comments?: string[] | undefined)
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/ppm.html
  *
- * @param buf
- * @param comments
+ * @param buf -
+ * @param comments -
  */
 export declare const asPPM: (buf: IntBuffer, comments?: string[] | undefined) => Uint8Array;
 //# sourceMappingURL=write.d.ts.map

package/write.js

@@ -4,10 +4,10 @@ const formatComments = (comments = ["generated by @thi.ng/pixel-io-netpbm"]) =>
  * Initializes byte array & PBM header for given {@link IntBuffer} and format
  * details.
  *
- * @param magic
- * @param limits
- * @param size
- * @param buf
+ * @param magic -
+ * @param limits -
+ * @param size -
+ * @param buf -
  *
  * @internal
  */
@@ -30,8 +30,8 @@ const initHeader = (magic, limits, size, buf, comments) => {
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pbm.html
  *
- * @param buf
- * @param comments
+ * @param buf -
+ * @param comments -
  */
 export const asPBM = (buf, comments) => {
     const { data, width, height } = buf;
@@ -58,8 +58,8 @@ export const asPBM = (buf, comments) => {
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pgm.html
  *
- * @param buf
- * @param comments
+ * @param buf -
+ * @param comments -
  */
 export const asPGM = (buf, comments) => {
     const { data, width, height } = buf;
@@ -76,8 +76,8 @@ export const asPGM = (buf, comments) => {
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/pgm.html
  *
- * @param buf
- * @param comments
+ * @param buf -
+ * @param comments -
  */
 export const asPGM16 = (buf, comments) => {
     if (buf.format !== GRAY16)
@@ -96,8 +96,8 @@ export const asPGM16 = (buf, comments) => {
  * @remarks
  * Reference: http://netpbm.sourceforge.net/doc/ppm.html
  *
- * @param buf
- * @param comments
+ * @param buf -
+ * @param comments -
  */
 export const asPPM = (buf, comments) => {
     const { data, width, height } = buf;