ensure-string - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

lib-esm/index.js

@@ -0,1 +1,2 @@
+import isutf8 from 'isutf8';
 /**
@@ -30,4 +31,7 @@ * Ensure that the data is string. If it is an ArrayBuffer it will be converted to string using TextDecoder.
     }
+    //@ts-expect-error an ArrayBuffer is also ok
+    if (!isutf8(blob))
+        return 'latin1';
     return 'utf-8';
 }
 //# sourceMappingURL=index.js.map

lib/index.d.ts

@@ -0,4 +1,6 @@
+import type { TextData } from 'cheminfo-types';
 export interface EnsureStringOptions {
-    /** Specify the encoding, by default 'utf8' or 'utf16'
-     * @default 'utf8' or utf16 if there is BOM utf16
+    /**
+     * Specify the encoding, by default 'utf8' or 'utf16'
+     * @default 'utf8' or utf16 if there is BOM utf16 or latin1 if it is not utf8
      */
@@ -13,2 +15,2 @@ encoding?: string;
  */
-export declare function ensureString(blob: string | ArrayBuffer | Uint8Array, options?: EnsureStringOptions): string;
+export declare function ensureString(blob: TextData, options?: EnsureStringOptions): string;

lib/index.js

 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ensureString = void 0;
+const isutf8_1 = __importDefault(require("isutf8"));
 /**
@@ -34,4 +38,7 @@ * Ensure that the data is string. If it is an ArrayBuffer it will be converted to string using TextDecoder.
     }
+    //@ts-expect-error an ArrayBuffer is also ok
+    if (!(0, isutf8_1.default)(blob))
+        return 'latin1';
     return 'utf-8';
 }
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "ensure-string",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Ensure that we receive a text even if an ArrayBuffer is sent",
@@ -44,11 +44,15 @@ "main": "./lib/index.js",
   "devDependencies": {
-    "@types/jest": "^27.0.1",
-    "eslint": "^7.32.0",
-    "eslint-config-cheminfo-typescript": "^8.0.9",
-    "jest": "^27.1.1",
-    "prettier": "^2.3.2",
+    "@types/jest": "^27.4.1",
+    "eslint": "^8.13.0",
+    "eslint-config-cheminfo-typescript": "^10.4.0",
+    "jest": "^27.5.1",
+    "prettier": "^2.6.2",
     "rimraf": "^3.0.2",
-    "ts-jest": "^27.0.3",
-    "typescript": "^4.4.2"
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.6.3"
+  },
+  "dependencies": {
+    "cheminfo-types": "^1.1.0",
+    "isutf8": "^4.0.0"
   }
 }

src/index.ts

@@ -0,4 +1,8 @@
+import type { TextData } from 'cheminfo-types';
+import isutf8 from 'isutf8';
+
 export interface EnsureStringOptions {
-  /** Specify the encoding, by default 'utf8' or 'utf16'
-   * @default 'utf8' or utf16 if there is BOM utf16
+  /**
+   * Specify the encoding, by default 'utf8' or 'utf16'
+   * @default 'utf8' or utf16 if there is BOM utf16 or latin1 if it is not utf8
    */
@@ -15,3 +19,3 @@ encoding?: string;
 export function ensureString(
-  blob: string | ArrayBuffer | Uint8Array,
+  blob: TextData,
   options: EnsureStringOptions = {},
@@ -42,3 +46,6 @@ ): string {
   }
+  //@ts-expect-error an ArrayBuffer is also ok
+  if (!isutf8(blob)) return 'latin1';
+
   return 'utf-8';
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11183

increased by9.05%

Lines of code

137

increased by15.13%

Worsened metrics

Dependency count

2

increased byInfinity%

Dependency changes

• + Addedcheminfo-types@^1.1.0

• + Addedisutf8@^4.0.0

• + Addedcheminfo-types@1.8.1(transitive)

• + Addedisutf8@4.0.1(transitive)