Initial implementation, tests, readme

ljharb · ljharb · commit 06afa73e7759 · 2022-11-18T21:38:45.000-08:00
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,13 @@
+{
+	"root": true,
+
+	"extends": "@ljharb",
+
+	"rules": {
+		"new-cap": ["error", {
+			"capIsNewExceptions": [
+				"GetIntrinsic",
+			],
+		}],
+	},
+}
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [ljharb]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: npm/is-array-buffer
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
diff --git a/.github/workflows/node-aught.yml b/.github/workflows/node-aught.yml
@@ -0,0 +1,18 @@
+name: 'Tests: node.js < 10'
+
+on: [pull_request, push]
+
+jobs:
+  tests:
+    uses: ljharb/actions/.github/workflows/node.yml@main
+    with:
+      range: '< 10'
+      type: minors
+      command: npm run tests-only
+
+  node:
+    name: 'node < 10'
+    needs: [tests]
+    runs-on: ubuntu-latest
+    steps:
+      - run: 'echo tests completed'
diff --git a/.github/workflows/node-pretest.yml b/.github/workflows/node-pretest.yml
@@ -0,0 +1,7 @@
+name: 'Tests: pretest/posttest'
+
+on: [pull_request, push]
+
+jobs:
+  tests:
+    uses: ljharb/actions/.github/workflows/pretest.yml@main
diff --git a/.github/workflows/node-tens.yml b/.github/workflows/node-tens.yml
@@ -0,0 +1,18 @@
+name: 'Tests: node.js >= 10'
+
+on: [pull_request, push]
+
+jobs:
+  tests:
+    uses: ljharb/actions/.github/workflows/node.yml@main
+    with:
+      range: '>= 10'
+      type: minors
+      command: npm run tests-only
+
+  node:
+    name: 'node >= 10'
+    needs: [tests]
+    runs-on: ubuntu-latest
+    steps:
+      - run: 'echo tests completed'
diff --git a/.github/workflows/rebase.yml b/.github/workflows/rebase.yml
@@ -0,0 +1,9 @@
+name: Automatic Rebase
+
+on: [pull_request_target]
+
+jobs:
+  _:
+    uses: ljharb/actions/.github/workflows/rebase.yml@main
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/require-allow-edits.yml b/.github/workflows/require-allow-edits.yml
@@ -0,0 +1,12 @@
+name: Require “Allow Edits”
+
+on: [pull_request_target]
+
+jobs:
+  _:
+    name: "Require “Allow Edits”"
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: ljharb/require-allow-edits@main
diff --git a/.npmrc b/.npmrc
@@ -1 +1,3 @@
 package-lock=false
+allow-same-version=true
+message=v%s
diff --git a/.nycrc b/.nycrc
@@ -0,0 +1,9 @@
+{
+	"all": true,
+	"check-coverage": false,
+	"reporter": ["text-summary", "text", "html", "json"],
+	"exclude": [
+		"coverage",
+		"test"
+	]
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
diff --git a/README.md b/README.md
@@ -1,2 +1,56 @@
-# is-array-buffer
+# is-array-buffer <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
+
+[![github actions][actions-image]][actions-url]
+[![coverage][codecov-image]][codecov-url]
+[![License][license-image]][license-url]
+[![Downloads][downloads-image]][downloads-url]
+
+[![npm badge][npm-badge-png]][package-url]
+
 Is this value a JS ArrayBuffer? This module works cross-realm/iframe, does not depend on `instanceof` or mutable properties, and despite ES6 Symbol.toStringTag.
+
+## Example
+
+```js
+var assert = require('assert');
+var isArrayBuffer = require('is-array-buffer');
+
+assert(!isArrayBuffer(function () {}));
+assert(!isArrayBuffer(null));
+assert(!isArrayBuffer(function* () { yield 42; return Infinity; });
+assert(!isArrayBuffer(Symbol('foo')));
+assert(!isArrayBuffer(1n));
+assert(!isArrayBuffer(Object(1n)));
+
+assert(!isArrayBuffer(new Set()));
+assert(!isArrayBuffer(new WeakSet()));
+assert(!isArrayBuffer(new Map()));
+assert(!isArrayBuffer(new WeakMap()));
+assert(!isArrayBuffer(new WeakRef({})));
+assert(!isArrayBuffer(new FinalizationRegistry(() => {})));
+assert(!isArrayBuffer(new SharedArrayBuffer()));
+
+assert(isArrayBuffer(new ArrayBuffer()));
+
+class MyArrayBuffer extends ArrayBuffer {}
+assert(isArrayBuffer(new MyArrayBuffer()));
+```
+
+## Tests
+Simply clone the repo, `npm install`, and run `npm test`
+
+[package-url]: https://npmjs.org/package/is-array-buffer
+[npm-version-svg]: https://versionbadg.es/inspect-js/is-array-buffer.svg
+[deps-svg]: https://david-dm.org/inspect-js/is-array-buffer.svg
+[deps-url]: https://david-dm.org/inspect-js/is-array-buffer
+[dev-deps-svg]: https://david-dm.org/inspect-js/is-array-buffer/dev-status.svg
+[dev-deps-url]: https://david-dm.org/inspect-js/is-array-buffer#info=devDependencies
+[npm-badge-png]: https://nodei.co/npm/is-array-buffer.png?downloads=true&stars=true
+[license-image]: https://img.shields.io/npm/l/is-array-buffer.svg
+[license-url]: LICENSE
+[downloads-image]: https://img.shields.io/npm/dm/is-array-buffer.svg
+[downloads-url]: https://npm-stat.com/charts.html?package=is-array-buffer
+[codecov-image]: https://codecov.io/gh/inspect-js/is-array-buffer/branch/main/graphs/badge.svg
+[codecov-url]: https://app.codecov.io/gh/inspect-js/is-array-buffer/
+[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/is-array-buffer
+[actions-url]: https://github.com/inspect-js/is-array-buffer/actions
diff --git a/index.js b/index.js
@@ -0,0 +1,42 @@
+'use strict';
+
+var callBind = require('call-bind');
+var callBound = require('call-bind/callBound');
+var GetIntrinsic = require('get-intrinsic');
+
+var $ArrayBuffer = GetIntrinsic('ArrayBuffer', true);
+var $Float32Array = GetIntrinsic('Float32Array', true);
+var $byteLength = callBound('ArrayBuffer.prototype.byteLength', true);
+
+// in node 0.10, ArrayBuffers have no prototype methods, but have an own slot-checking `slice` method
+var abSlice = $ArrayBuffer && !$byteLength && new $ArrayBuffer().slice;
+var $abSlice = abSlice && callBind(abSlice);
+
+module.exports = $byteLength || $abSlice
+	? function isArrayBuffer(obj) {
+		if (!obj || typeof obj !== 'object') {
+			return false;
+		}
+		try {
+			if ($byteLength) {
+				$byteLength(obj);
+			} else {
+				$abSlice(obj, 0);
+			}
+			return true;
+		} catch (e) {
+			return false;
+		}
+	}
+	: $Float32Array
+		// in node 0.8, ArrayBuffers have no prototype or own methods
+		? function IsArrayBuffer(obj) {
+			try {
+				return (new $Float32Array(obj)).buffer === obj;
+			} catch (e) {
+				return false;
+			}
+		}
+		: function isArrayBuffer(obj) { // eslint-disable-line no-unused-vars
+			return false;
+		};
diff --git a/package.json b/package.json
@@ -7,9 +7,18 @@
 		".": "./index.js",
 		"./package.json": "./package.json"
 	},
+	"sideEffects": false,
 	"scripts": {
 		"prepack": "npmignore --auto --commentLines=autogenerated",
-		"test": "echo \"Error: no test specified\" && exit 1"
+		"prepublishOnly": "safe-publish-latest",
+		"prepublish": "not-in-publish || npm run prepublishOnly",
+		"lint": "eslint --ext=.js,.mjs .",
+		"pretest": "npm run lint",
+		"tests-only": "nyc tape 'test/**/*.js'",
+		"test": "npm run tests-only --",
+		"posttest": "aud --production",
+		"version": "auto-changelog && git add CHANGELOG.md",
+		"postversion": "auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""
 	},
 	"repository": {
 		"type": "git",
@@ -24,13 +33,39 @@
 		"buffer"
 	],
 	"author": "Jordan Harband <ljharb@gmail.com>",
+	"funding": {
+		"url": "https://github.com/sponsors/ljharb"
+	},
 	"license": "MIT",
 	"bugs": {
 		"url": "https://github.com/inspect-js/is-array-buffer/issues"
 	},
 	"homepage": "https://github.com/inspect-js/is-array-buffer#readme",
 	"devDependencies": {
+		"@ljharb/eslint-config": "^21.0.0",
+		"aud": "^2.0.1",
+		"auto-changelog": "^2.4.0",
+		"es-value-fixtures": "^1.4.2",
+		"eslint": "=8.8.0",
+		"for-each": "^0.3.3",
+		"in-publish": "^2.0.1",
 		"npmignore": "^0.3.0",
+		"nyc": "^10.3.2",
+		"object-inspect": "^1.12.2",
+		"safe-publish-latest": "^2.0.0",
+		"tape": "^5.6.1"
+	},
+	"auto-changelog": {
+		"output": "CHANGELOG.md",
+		"template": "keepachangelog",
+		"unreleased": false,
+		"commitLimit": false,
+		"backfillLimit": false,
+		"hideCredit": true
+	},
+	"dependencies": {
+		"call-bind": "^1.0.2",
+		"get-intrinsic": "^1.1.3"
 	},
 	"publishConfig": {
 		"ignore": [
diff --git a/test/index.js b/test/index.js
@@ -0,0 +1,30 @@
+'use strict';
+
+var test = require('tape');
+var inspect = require('object-inspect');
+var forEach = require('for-each');
+var v = require('es-value-fixtures');
+
+var isArrayBuffer = require('..');
+
+test('isArrayBuffer', function (t) {
+	t.equal(typeof isArrayBuffer, 'function', 'is a function');
+
+	var nonABs = v.primitives.concat(
+		v.objects,
+		typeof SharedArrayBuffer === 'function' ? new SharedArrayBuffer() : []
+	);
+	forEach(nonABs, function (nonAB) {
+		t.equal(isArrayBuffer(nonAB), false, inspect(nonAB) + ' is not an ArrayBuffer');
+	});
+
+	t.test('actual ArrayBuffer instances', { skip: typeof ArrayBuffer === 'undefined' }, function (st) {
+		var ab = new ArrayBuffer();
+
+		st.equal(isArrayBuffer(ab), true, inspect(ab) + ' is an ArrayBuffer');
+
+		st.end();
+	});
+
+	t.end();
+});

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`package-lock=false`
	`2`	`+allow-same-version=true`
	`3`	`+message=v%s`