Initial implementation, tests, readme

.eslintrc

@@ -0,0 +1,5 @@
+{
+	"root": true,
+
+	"extends": "@ljharb",
+}

.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/array-buffer-byte-length
+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']

.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'

.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

.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'

.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 }}

.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

.gitignore

@@ -107,3 +107,5 @@ dist
 npm-shrinkwrap.json
 package-lock.json
 yarn.lock
+
+.npmignore

.npmrc

@@ -1 +1,3 @@
 package-lock=false
+allow-same-version=true
+message=v%s

.nycrc

@@ -0,0 +1,13 @@
+{
+	"all": true,
+	"check-coverage": false,
+	"reporter": ["text-summary", "text", "html", "json"],
+	"lines": 86,
+	"statements": 85.93,
+	"functions": 82.43,
+	"branches": 76.06,
+	"exclude": [
+		"coverage",
+		"test"
+	]
+}

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).

README.md

@@ -1,2 +1,40 @@
-# array-buffer-byte-length
+# array-buffer-byte-length <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]
+
 Get the byte length of an ArrayBuffer, even in engines without a `.byteLength` method.
+
+## Example
+
+```js
+const assert = require('assert');
+const byteLength = require('array-buffer-byte-length');
+
+assert.equal(byteLength([]), NaN, 'an array is not an ArrayBuffer, yields NaN');
+
+assert.equal(byteLength(new ArrayBuffer(0)), 0, 'ArrayBuffer of byteLength 0, yields 0');
+```
+
+## Tests
+Simply clone the repo, `npm install`, and run `npm test`
+
+[package-url]: https://npmjs.org/package/array-buffer-byte-length
+[npm-version-svg]: https://versionbadg.es/inspect-js/array-buffer-byte-length.svg
+[deps-svg]: https://david-dm.org/inspect-js/array-buffer-byte-length.svg
+[deps-url]: https://david-dm.org/inspect-js/array-buffer-byte-length
+[dev-deps-svg]: https://david-dm.org/inspect-js/array-buffer-byte-length/dev-status.svg
+[dev-deps-url]: https://david-dm.org/inspect-js/array-buffer-byte-length#info=devDependencies
+[npm-badge-png]: https://nodei.co/npm/array-buffer-byte-length.png?downloads=true&stars=true
+[license-image]: https://img.shields.io/npm/l/array-buffer-byte-length.svg
+[license-url]: LICENSE
+[downloads-image]: https://img.shields.io/npm/dm/array-buffer-byte-length.svg
+[downloads-url]: https://npm-stat.com/charts.html?package=array-buffer-byte-length
+[codecov-image]: https://codecov.io/gh/inspect-js/array-buffer-byte-length/branch/main/graphs/badge.svg
+[codecov-url]: https://app.codecov.io/gh/inspect-js/array-buffer-byte-length/
+[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/array-buffer-byte-length
+[actions-url]: https://github.com/inspect-js/array-buffer-byte-length/actions

index.js

@@ -0,0 +1,13 @@
+'use strict';
+
+var callBound = require('call-bind/callBound');
+var $byteLength = callBound('ArrayBuffer.prototype.byteLength', true);
+
+var isArrayBuffer = require('is-array-buffer');
+
+module.exports = function byteLength(ab) {
+	if (!isArrayBuffer(ab)) {
+		return NaN;
+	}
+	return $byteLength ? $byteLength(ab) : ab.byteLength;
+}; // in node < 0.11, byteLength is an own nonconfigurable property

package.json

@@ -3,8 +3,22 @@
 	"version": "0.0.0",
 	"description": "Get the byte length of an ArrayBuffer, even in engines without a `.byteLength` method.",
 	"main": "index.js",
+	"exports": {
+		".": "./index.js",
+		"./package.json": "./package.json"
+	},
 	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
+		"prepack": "npmignore --auto --commentLines=autogenerated",
+		"prepublishOnly": "safe-publish-latest",
+		"prepublish": "not-in-publish || npm run prepublishOnly",
+		"pretest": "npm run lint",
+		"prelint": "evalmd README.md",
+		"lint": "eslint --ext=js,mjs .",
+		"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)\")\""
 	},
 	"keywords": [
 		"shim",
@@ -17,6 +31,9 @@
 		"es-shims"
 	],
 	"author": "Jordan Harband <ljharb@gmail.com>",
+	"funding": {
+		"url": "https://github.com/sponsors/ljharb"
+	},
 	"license": "MIT",
 	"repository": {
 		"type": "git",
@@ -25,5 +42,40 @@
 	"bugs": {
 		"url": "https://github.com/inspect-js/array-buffer-byte-length/issues"
 	},
-	"homepage": "https://github.com/inspect-js/array-buffer-byte-length#readme"
+	"homepage": "https://github.com/inspect-js/array-buffer-byte-length#readme",
+	"dependencies": {
+		"call-bind": "^1.0.2",
+		"is-array-buffer": "^3.0.1"
+	},
+	"devDependencies": {
+		"@ljharb/eslint-config": "^21.0.1",
+		"aud": "^2.0.2",
+		"auto-changelog": "^2.4.0",
+		"es-value-fixtures": "^1.4.2",
+		"eslint": "=8.8.0",
+		"evalmd": "^0.0.19",
+		"for-each": "^0.3.3",
+		"in-publish": "^2.0.1",
+		"npmignore": "^0.3.0",
+		"nyc": "^10.3.2",
+		"object-inspect": "^1.12.3",
+		"safe-publish-latest": "^2.0.0",
+		"tape": "^5.6.3"
+	},
+	"auto-changelog": {
+		"output": "CHANGELOG.md",
+		"template": "keepachangelog",
+		"unreleased": false,
+		"commitLimit": false,
+		"backfillLimit": false,
+		"hideCredit": true
+	},
+	"testling": {
+		"files": "test/index.js"
+	},
+	"publishConfig": {
+		"ignore": [
+			".github/workflows"
+		]
+	}
 }

test/index.js

@@ -0,0 +1,26 @@
+'use strict';
+
+var test = require('tape');
+var forEach = require('for-each');
+var v = require('es-value-fixtures');
+var inspect = require('object-inspect');
+
+var byteLength = require('../');
+
+test('byteLength', function (t) {
+	forEach(v.objects.concat(v.primitives), function (nonAB) {
+		t.equal(byteLength(nonAB), NaN, inspect(nonAB) + ' is not an ArrayBuffer, and yields NaN');
+	});
+
+	t.test('ArrayBuffers', { skip: typeof ArrayBuffer !== 'function' }, function (st) {
+		var ab32 = new ArrayBuffer(32);
+		st.equal(byteLength(ab32), 32, 'works on an ArrayBuffer of length 32: ' + inspect(ab32));
+
+		var ab0 = new ArrayBuffer(0);
+		st.equal(byteLength(ab0), 0, 'works on an ArrayBuffer of length 0: ' + inspect(ab0));
+
+		st.end();
+	});
+
+	t.end();
+});