isutf8 4.0.1 → 4.0.4

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Denis Seleznev, hcodes@yandex.ru
+Copyright (c) 2026 Denis Seleznev, hcodes@yandex.ru
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,49 +1,127 @@
 [![NPM Version](https://img.shields.io/npm/v/isutf8.svg?style=flat)](https://www.npmjs.org/package/isutf8)
 [![NPM Downloads](https://img.shields.io/npm/dm/isutf8.svg?style=flat)](https://www.npmjs.org/package/isutf8)
-[![Bundlephobia](https://badgen.net/bundlephobia/minzip/isutf8)](https://bundlephobia.com/result?p=isutf8)
 [![install size](https://packagephobia.com/badge?p=isutf8)](https://packagephobia.com/result?p=isutf8)
 
 isutf8
 ======
 
+> **Deprecated:** Use [`isUtf8` from `node:buffer`](https://nodejs.org/api/buffer.html#bufferisutf8input)
+> in Node.js, or [`TextDecoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder/decode)
+> with `{ fatal: true }` in browsers. See the migration examples below.
+
 Quick check if a Node.js Buffer or Uint8Array is valid UTF-8.
 
 ## Advantages
+
 - Ultra-small package size
-- No dependencies
-- No pre-compilation
+- No runtime dependencies
+- No native compilation required
+
+## Migration to built-in APIs
+
+For modern Node.js applications, prefer the built-in
+[`isUtf8` from `node:buffer`](https://nodejs.org/api/buffer.html#bufferisutf8input),
+available since Node.js 18.14.0 and 19.4.0:
+
+```js
+import { isUtf8 } from 'node:buffer';
+
+console.log(isUtf8(Buffer.from([0xd0, 0x90]))); // true
+```
+
+In modern browsers, use
+[`TextDecoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder/decode)
+with `fatal: true` to reject invalid UTF-8:
+
+```js
+function isUtf8(input) {
+  if (input === undefined) return false;
+
+  try {
+    new TextDecoder('utf-8', { fatal: true }).decode(input);
+    return true;
+  } catch (error) {
+    if (error instanceof TypeError) return false;
+    throw error;
+  }
+}
+
+console.log(isUtf8(new Uint8Array([0xd0, 0x90]))); // true
+console.log(isUtf8(new Uint8Array([0xc3]))); // false
+```
+
+Unlike a byte-only validator, `TextDecoder` also produces a decoded string.
+This package mainly remains useful for older environments without these APIs
+(it supports Node.js 12 or later), or for retaining its existing API.
+When migrating, note that this package returns `false` for a missing argument,
+while Node.js's built-in `isUtf8` throws a `TypeError`.
 
 ## Install
-`npm install isutf8`
+
+```sh
+npm install isutf8
+```
 
 ## Usage
 
 ### CommonJS
+
 ```js
 const isUtf8 = require('isutf8');
 
 const buf = Buffer.from([0xd0, 0x90]);
-console.log(isUtf8(buf)); // => boolean
+console.log(isUtf8(buf)); // true
 
-// or 
+// or
 
 const arr = new Uint8Array([0xd0, 0x90]);
-console.log(isUtf8(arr)); // => boolean
-
+console.log(isUtf8(arr)); // true
 ```
 
 ### ES Modules or TypeScript
+
 ```js
 import isUtf8 from 'isutf8';
 
 const buf = Buffer.from([0xd0, 0x90]);
-console.log(isUtf8(buf)); // => boolean
+console.log(isUtf8(buf)); // true
 
-// or 
+// or
 
 const arr = new Uint8Array([0xd0, 0x90]);
-console.log(isUtf8(arr)); // => boolean
+console.log(isUtf8(arr)); // true
 ```
 
+## API
+
+`isUtf8(input?: Buffer | Uint8Array): boolean`
+
+Returns `true` for valid UTF-8 byte sequences, including ASCII and empty input.
+Returns `false` for invalid or incomplete sequences, or a missing argument.
+It validates bytes; it does not detect the original encoding or decode text.
+
+```js
+const isUtf8 = require('isutf8');
+
+console.log(isUtf8(new Uint8Array())); // true
+console.log(isUtf8(new Uint8Array([0xc3]))); // false: incomplete sequence
+console.log(isUtf8()); // false
+```
+
+## Development
+
+Use Node.js 22.13.0 or later in the Node.js 22 line, or Node.js 24 or later,
+for the development tools.
+
+```sh
+npm ci
+npm test
+npm run build
+```
+
+TypeScript is kept on 6.0.x because the current `typescript-eslint` and `ts-jest`
+releases do not support TypeScript 7 yet.
+
 ## License
+
 [MIT License](./LICENSE)

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 /**
  * Check if a Node.js Buffer or Uint8Array is UTF-8.
  */

package/dist/index.esm.js

@@ -25,7 +25,9 @@ function isUtf8(buf) {
     if (!buf) {
         return false;
     }
+    // eslint-disable-next-line no-var
     var i = 0;
+    // eslint-disable-next-line no-var
     var len = buf.length;
     while (i < len) {
         // UTF8-1 = %x00-7F

package/dist/index.js

@@ -27,7 +27,9 @@ function isUtf8(buf) {
     if (!buf) {
         return false;
     }
+    // eslint-disable-next-line no-var
     var i = 0;
+    // eslint-disable-next-line no-var
     var len = buf.length;
     while (i < len) {
         // UTF8-1 = %x00-7F

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "isutf8",
   "description": "Check if a Node.js Buffer or Uint8Array is UTF-8",
-  "version": "4.0.1",
+  "version": "4.0.4",
+  "deprecated": "Use isUtf8 from node:buffer in modern Node.js, or TextDecoder with { fatal: true } in browsers.",
   "author": {
     "name": "Denis Seleznev",
     "email": "hcodes@yandex.ru",
@@ -35,20 +36,24 @@
     "node": ">= 12"
   },
   "devDependencies": {
-    "@rollup/plugin-typescript": "^11.1.6",
-    "@types/jest": "^29.5.12",
-    "@typescript-eslint/eslint-plugin": "^8.3.0",
-    "@typescript-eslint/parser": "^8.3.0",
-    "del-cli": "^5.1.0",
-    "eslint": "^8.3.0",
-    "jest": "^29.7.0",
-    "rollup": "^4.21.1",
-    "ts-jest": "^29.2.5",
-    "tslib": "^2.7.0",
-    "typescript": "^5.5.4"
+    "@eslint/js": "^10.0.1",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.20.2",
+    "@typescript-eslint/eslint-plugin": "^8.70.0",
+    "@typescript-eslint/parser": "^8.70.0",
+    "del-cli": "^7.0.0",
+    "eslint": "^10.10.0",
+    "globals": "^17.12.0",
+    "jest": "^30.5.1",
+    "rollup": "^4.63.1",
+    "ts-jest": "^29.4.12",
+    "tslib": "^2.8.1",
+    "typescript": "~6.0.3",
+    "typescript-eslint": "^8.70.0"
   },
   "scripts": {
-    "test": "npm run eslint && npm run unit",
+    "test": "npm run eslint && npm run typecheck && npm run unit",
     "eslint": "eslint --ext .ts",
     "clean": "del-cli dist/*",
     "unit": "jest --config ./jest.config.js",