[patch] add types

Author: ljharb

.github/workflows/node-aught.yml

@@ -9,10 +9,11 @@ jobs:
       range: '< 10'
       type: minors
       command: npm run tests-only
+      skip-ls-check: true
 
   node:
     name: 'node < 10'
     needs: [tests]
     runs-on: ubuntu-latest
     steps:
-      - run: 'echo tests completed'
+      - run: true

.github/workflows/node-tens.yml

@@ -15,4 +15,4 @@ jobs:
     needs: [tests]
     runs-on: ubuntu-latest
     steps:
-      - run: 'echo tests completed'
+      - run: true

index.d.ts

@@ -0,0 +1,3 @@
+declare function isDataView(value: unknown): value is DataView;
+
+export = isDataView;

index.js

@@ -7,11 +7,12 @@ var $DataView = GetIntrinsic('%DataView%', true);
 
 var callBound = require('call-bind/callBound');
 
+// node <= 0.10, < 0.11.4 has a nonconfigurable own property instead of a prototype getter
 var $dataViewBuffer = callBound('DataView.prototype.buffer', true);
 
 var isTypedArray = require('is-typed-array');
 
-// node <= 0.10, < 0.11.4 has a nonconfigurable own property instead of a prototype getter
+/** @type {import('.')} */
 module.exports = function isDataView(x) {
 	if (!x || typeof x !== 'object' || !$DataView || isTypedArray(x)) {
 		return false;
@@ -26,20 +27,13 @@ module.exports = function isDataView(x) {
 		}
 	}
 
-	/*
-	 * try {
-	 * new $DataView(x); // eslint-disable-line no-new
-	 * x is an ArrayBuffer
-	 * } catch (e) {
-	 */
 	if (
 		('getInt8' in x)
 			&& typeof x.getInt8 === 'function'
 			&& x.getInt8 === new $DataView(new $ArrayBuffer(1)).getInt8
 	) {
 		return true;
 	}
-	// }
 
 	return false;
 };

package.json

@@ -7,12 +7,14 @@
 		".": "./index.js",
 		"./package.json": "./package.json"
 	},
+	"types": "./index.d.ts",
 	"scripts": {
 		"prepack": "npmignore --auto --commentLines=autogenerated",
 		"prepublishOnly": "safe-publish-latest",
 		"prepublish": "not-in-publish || npm run prepublishOnly",
 		"prelint": "evalmd README.md",
 		"lint": "eslint --ext=js,mjs .",
+		"postlint": "tsc -p .",
 		"pretest": "npm run lint",
 		"tests-only": "nyc tape 'test/**/*.js'",
 		"test": "npm run tests-only",
@@ -47,6 +49,14 @@
 	},
 	"devDependencies": {
 		"@ljharb/eslint-config": "^21.1.0",
+		"@types/call-bind": "^1.0.5",
+		"@types/es-value-fixtures": "^1.4.4",
+		"@types/for-each": "^0.3.3",
+		"@types/make-arrow-function": "^1.2.2",
+		"@types/make-generator-function": "^2.0.3",
+		"@types/node": "^20.11.14",
+		"@types/object-inspect": "^1.8.4",
+		"@types/tape": "^5.6.4",
 		"aud": "^2.0.4",
 		"auto-changelog": "^2.4.0",
 		"available-typed-arrays": "^1.0.6",
@@ -62,7 +72,8 @@
 		"nyc": "^10.3.2",
 		"object-inspect": "^1.13.1",
 		"safe-publish-latest": "^2.0.0",
-		"tape": "^5.7.4"
+		"tape": "^5.7.4",
+		"typescript": "next"
 	},
 	"testling": {
 		"files": "test/index.js"

test/index.js

@@ -12,13 +12,15 @@ var inspect = require('object-inspect');
 var availableTypedArrays = require('available-typed-arrays')();
 
 test('not DataViews', function (t) {
-	forEach(v.primitives.concat(
+	forEach([].concat(
+		// @ts-expect-error TS sucks at [].concat
+		v.primitives,
 		v.objects,
 		function () {},
 		generators,
 		arrowFns,
 		[]
-	), function (nonDV) {
+	), /** @type {(nonDV: unknown) => void} */ function (nonDV) {
 		t.equal(
 			isDataView(nonDV),
 			false,
@@ -37,8 +39,11 @@ test('not DataViews', function (t) {
 
 test('@@toStringTag', { skip: !hasToStringTag }, function (t) {
 	forEach(availableTypedArrays, function (typedArray) {
+		// @ts-expect-error
 		var fakeTypedArray = [];
+		// @ts-expect-error
 		fakeTypedArray[Symbol.toStringTag] = typedArray;
+		// @ts-expect-error
 		t.notOk(isDataView(fakeTypedArray), 'faked ' + typedArray + ' is not typed array');
 	});
 
@@ -49,7 +54,7 @@ test('Data Views', { skip: typeof DataView !== 'function' }, function (t) {
 	var ab = new ArrayBuffer(1);
 	var dv = new DataView(ab);
 
-	t.equal(isDataView(dv), true, inspect(dv) + 'is a DataView');
+	t.equal(isDataView(dv), true, inspect(dv) + ' is a DataView');
 
 	t.end();
 });

tsconfig.json

@@ -0,0 +1,49 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+
+    /* Language and Environment */
+    "target": "ESNext",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    "useDefineForClassFields": true,                     /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    "typeRoots": ["types"],                              /* Specify multiple folders that act like './node_modules/@types'. */
+    "resolveJsonModule": true,                           /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+
+    /* JavaScript Support */
+    "allowJs": true,                                     /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    "checkJs": true,                                     /* Enable error reporting in type-checked JavaScript files. */
+    "maxNodeModuleJsDepth": 0,                           /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,                                 /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declarationMap": true,                              /* Create sourcemaps for d.ts files. */
+    "noEmit": true,                                      /* Disable emitting files from a compilation. */
+
+    /* Interop Constraints */
+    "allowSyntheticDefaultImports": true,                /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+
+    /* Completeness */
+    //"skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "exclude": [
+    "coverage"
+  ]
+}