typed-array-byte-offset 1.0.0

package/.eslintrc

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

package/.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/typed-array-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']

package/.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"
+	]
+}

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# 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).
+
+## v1.0.0 - 2023-06-06
+
+### Commits
+
+- Initial implementation, tests, readme [`f227633`](https://github.com/inspect-js/typed-array-byte-offset/commit/f2276337a907bdfe9725af1b36c3109e76f2430d)
+- Initial commit [`806bbaf`](https://github.com/inspect-js/typed-array-byte-offset/commit/806bbaf81e0267aebce5ae68cbf138718513642a)
+- npm init [`1151981`](https://github.com/inspect-js/typed-array-byte-offset/commit/1151981427eb1fddab8599d36e6afea50a78293f)
+- Only apps should have lockfiles [`5fa9933`](https://github.com/inspect-js/typed-array-byte-offset/commit/5fa9933275f10bdb9e8a175cc70a8228d4811642)

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Inspect JS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# typed-array-byte-offset <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]
+
+Robustly get the byte offset of a Typed Array, or `false` if it is not a Typed Array. Works cross-realm, in every engine, even if the `byteOffset` property is overridden.
+
+## Example
+
+```js
+var typedArrayByteOffset = require('typed-array-byte-offset');
+var assert = require('assert');
+
+assert.equal(false, typedArrayByteOffset(undefined));
+assert.equal(false, typedArrayByteOffset(null));
+assert.equal(false, typedArrayByteOffset(false));
+assert.equal(false, typedArrayByteOffset(true));
+assert.equal(false, typedArrayByteOffset([]));
+assert.equal(false, typedArrayByteOffset({}));
+assert.equal(false, typedArrayByteOffset(/a/g));
+assert.equal(false, typedArrayByteOffset(new RegExp('a', 'g')));
+assert.equal(false, typedArrayByteOffset(new Date()));
+assert.equal(false, typedArrayByteOffset(42));
+assert.equal(false, typedArrayByteOffset(NaN));
+assert.equal(false, typedArrayByteOffset(Infinity));
+assert.equal(false, typedArrayByteOffset(new Number(42)));
+assert.equal(false, typedArrayByteOffset('foo'));
+assert.equal(false, typedArrayByteOffset(Object('foo')));
+assert.equal(false, typedArrayByteOffset(function () {}));
+assert.equal(false, typedArrayByteOffset(function* () {}));
+assert.equal(false, typedArrayByteOffset(x => x * x));
+assert.equal(false, typedArrayByteOffset([]));
+
+const buffer = new ArrayBuffer(32);
+
+assert.equal(8, typedArrayByteOffset(new Int8Array(buffer, 8)));
+assert.equal(8, typedArrayByteOffset(new Uint8Array(buffer, 8)));
+assert.equal(8, typedArrayByteOffset(new Uint8ClampedArray(buffer, 8)));
+assert.equal(4, typedArrayByteOffset(new Int16Array(buffer, 4)));
+assert.equal(4, typedArrayByteOffset(new Uint16Array(buffer, 4)));
+assert.equal(8, typedArrayByteOffset(new Int32Array(buffer, 8)));
+assert.equal(8, typedArrayByteOffset(new Uint32Array(buffer, 8)));
+assert.equal(16, typedArrayByteOffset(new Float32Array(buffer, 16)));
+assert.equal(16, typedArrayByteOffset(new Float64Array(buffer, 16)));
+assert.equal(16, typedArrayByteOffset(new BigInt64Array(buffer, 16)));
+assert.equal(16, typedArrayByteOffset(new BigUint64Array(buffer, 16)));
+```
+
+## Tests
+Simply clone the repo, `npm install`, and run `npm test`
+
+[package-url]: https://npmjs.org/package/typed-array-byte-offset
+[npm-version-svg]: https://versionbadg.es/inspect-js/typed-array-byte-offset.svg
+[deps-svg]: https://david-dm.org/inspect-js/typed-array-byte-offset.svg
+[deps-url]: https://david-dm.org/inspect-js/typed-array-byte-offset
+[dev-deps-svg]: https://david-dm.org/inspect-js/typed-array-byte-offset/dev-status.svg
+[dev-deps-url]: https://david-dm.org/inspect-js/typed-array-byte-offset#info=devDependencies
+[npm-badge-png]: https://nodei.co/npm/typed-array-byte-offset.png?downloads=true&stars=true
+[license-image]: https://img.shields.io/npm/l/typed-array-byte-offset.svg
+[license-url]: LICENSE
+[downloads-image]: https://img.shields.io/npm/dm/typed-array-byte-offset.svg
+[downloads-url]: https://npm-stat.com/charts.html?package=typed-array-byte-offset
+[codecov-image]: https://codecov.io/gh/inspect-js/typed-array-byte-offset/branch/main/graphs/badge.svg
+[codecov-url]: https://app.codecov.io/gh/inspect-js/typed-array-byte-offset/
+[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/typed-array-byte-offset
+[actions-url]: https://github.com/inspect-js/typed-array-byte-offset/actions

package/index.js

@@ -0,0 +1,66 @@
+'use strict';
+
+var forEach = require('for-each');
+var callBind = require('call-bind');
+
+var typedArrays = require('available-typed-arrays')();
+
+var getters = {};
+var hasProto = require('has-proto')();
+
+var gOPD = Object.getOwnPropertyDescriptor;
+var oDP = Object.defineProperty;
+if (gOPD) {
+	var getByteOffset = function (x) {
+		return x.byteOffset;
+	};
+	forEach(typedArrays, function (typedArray) {
+		// In Safari 7, Typed Array constructors are typeof object
+		if (typeof global[typedArray] === 'function' || typeof global[typedArray] === 'object') {
+			var Proto = global[typedArray].prototype;
+			var descriptor = gOPD(Proto, 'byteOffset');
+			if (!descriptor && hasProto) {
+				var superProto = Proto.__proto__; // eslint-disable-line no-proto
+				descriptor = gOPD(superProto, 'byteOffset');
+			}
+			// Opera 12.16 has a magic byteOffset data property on instances AND on Proto
+			if (descriptor && descriptor.get) {
+				getters[typedArray] = callBind(descriptor.get);
+			} else if (oDP) {
+				// this is likely an engine where instances have a magic byteOffset data property
+				var arr = new global[typedArray](2);
+				descriptor = gOPD(arr, 'byteOffset');
+				if (descriptor && descriptor.configurable) {
+					oDP(arr, 'length', { value: 3 });
+				}
+				if (arr.length === 2) {
+					getters[typedArray] = getByteOffset;
+				}
+			}
+		}
+	});
+}
+
+var tryTypedArrays = function tryAllTypedArrays(value) {
+	var foundOffset;
+	forEach(getters, function (getter) {
+		if (typeof foundOffset !== 'number') {
+			try {
+				var offset = getter(value);
+				if (typeof offset === 'number') {
+					foundOffset = offset;
+				}
+			} catch (e) {}
+		}
+	});
+	return foundOffset;
+};
+
+var isTypedArray = require('is-typed-array');
+
+module.exports = function typedArrayByteOffset(value) {
+	if (!isTypedArray(value)) {
+		return false;
+	}
+	return tryTypedArrays(value);
+};

package/package.json

@@ -0,0 +1,98 @@
+{
+	"name": "typed-array-byte-offset",
+	"version": "1.0.0",
+	"description": "Robustly get the byte offset of a Typed Array",
+	"main": "index.js",
+	"exports": {
+		".": "./index.js",
+		"./package.json": "./package.json"
+	},
+	"scripts": {
+		"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)\")\""
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/inspect-js/typed-array-byte-offset.git"
+	},
+	"keywords": [
+		"typed",
+		"array",
+		"byteOffset",
+		"byte",
+		"offset",
+		"robust",
+		"es",
+		"Int8Array",
+		"Uint8Array",
+		"Uint8ClampedArray",
+		"Int16Array",
+		"Uint16Array",
+		"Int32Array",
+		"Uint32Array",
+		"Float32Array",
+		"Float64Array",
+		"BigInt64Array",
+		"BigUint64Array"
+	],
+	"author": "Jordan Harband <ljharb@gmail.com>",
+	"funding": {
+		"url": "https://github.com/sponsors/ljharb"
+	},
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/inspect-js/typed-array-byte-offset/issues"
+	},
+	"homepage": "https://github.com/inspect-js/typed-array-byte-offset#readme",
+	"dependencies": {
+		"available-typed-arrays": "^1.0.5",
+		"call-bind": "^1.0.2",
+		"for-each": "^0.3.3",
+		"has-proto": "^1.0.1",
+		"is-typed-array": "^1.1.10"
+	},
+	"devDependencies": {
+		"@ljharb/eslint-config": "^21.1.0",
+		"aud": "^2.0.2",
+		"auto-changelog": "^2.4.0",
+		"eslint": "=8.8.0",
+		"evalmd": "^0.0.19",
+		"in-publish": "^2.0.1",
+		"is-callable": "^1.2.7",
+		"make-arrow-function": "^1.2.0",
+		"make-generator-function": "^2.0.0",
+		"npmignore": "^0.3.0",
+		"nyc": "^10.3.2",
+		"object-inspect": "^1.12.3",
+		"safe-publish-latest": "^2.0.0",
+		"tape": "^5.6.3"
+	},
+	"engines": {
+		"node": ">= 0.4"
+	},
+	"auto-changelog": {
+		"output": "CHANGELOG.md",
+		"template": "keepachangelog",
+		"unreleased": false,
+		"commitLimit": false,
+		"backfillLimit": false,
+		"hideCredit": true
+	},
+	"testling": {
+		"files": "test/index.js"
+	},
+	"publishConfig": {
+		"ignore": [
+			".github/workflows"
+		]
+	}
+}

package/test/index.js

@@ -0,0 +1,88 @@
+'use strict';
+
+var test = require('tape');
+var typedArrayByteOffset = require('../');
+var isCallable = require('is-callable');
+var generators = require('make-generator-function')();
+var arrowFn = require('make-arrow-function')();
+var forEach = require('for-each');
+var inspect = require('object-inspect');
+
+var typedArrayNames = [
+	'Int8Array',
+	'Uint8Array',
+	'Uint8ClampedArray',
+	'Int16Array',
+	'Uint16Array',
+	'Int32Array',
+	'Uint32Array',
+	'Float32Array',
+	'Float64Array',
+	'BigInt64Array',
+	'BigUint64Array'
+];
+
+test('not arrays', function (t) {
+	t.test('non-number/string primitives', function (st) {
+		st.equal(false, typedArrayByteOffset(), 'undefined is not typed array');
+		st.equal(false, typedArrayByteOffset(null), 'null is not typed array');
+		st.equal(false, typedArrayByteOffset(false), 'false is not typed array');
+		st.equal(false, typedArrayByteOffset(true), 'true is not typed array');
+		st.end();
+	});
+
+	t.equal(false, typedArrayByteOffset({}), 'object is not typed array');
+	t.equal(false, typedArrayByteOffset(/a/g), 'regex literal is not typed array');
+	t.equal(false, typedArrayByteOffset(new RegExp('a', 'g')), 'regex object is not typed array');
+	t.equal(false, typedArrayByteOffset(new Date()), 'new Date() is not typed array');
+
+	t.test('numbers', function (st) {
+		st.equal(false, typedArrayByteOffset(42), 'number is not typed array');
+		st.equal(false, typedArrayByteOffset(Object(42)), 'number object is not typed array');
+		st.equal(false, typedArrayByteOffset(NaN), 'NaN is not typed array');
+		st.equal(false, typedArrayByteOffset(Infinity), 'Infinity is not typed array');
+		st.end();
+	});
+
+	t.test('strings', function (st) {
+		st.equal(false, typedArrayByteOffset('foo'), 'string primitive is not typed array');
+		st.equal(false, typedArrayByteOffset(Object('foo')), 'string object is not typed array');
+		st.end();
+	});
+
+	t.end();
+});
+
+test('Functions', function (t) {
+	t.equal(false, typedArrayByteOffset(function () {}), 'function is not typed array');
+	t.end();
+});
+
+test('Generators', { skip: generators.length === 0 }, function (t) {
+	forEach(generators, function (genFn) {
+		t.equal(false, typedArrayByteOffset(genFn), 'generator function ' + inspect(genFn) + ' is not typed array');
+	});
+	t.end();
+});
+
+test('Arrow functions', { skip: !arrowFn }, function (t) {
+	t.equal(false, typedArrayByteOffset(arrowFn), 'arrow function is not typed array');
+	t.end();
+});
+
+test('Typed Arrays', function (t) {
+	var length = 32;
+	var byteOffset = 16;
+
+	forEach(typedArrayNames, function (typedArray) {
+		var buffer = new ArrayBuffer(length);
+		var TypedArray = global[typedArray];
+		if (isCallable(TypedArray)) {
+			var arr = new TypedArray(buffer, byteOffset);
+			t.equal(typedArrayByteOffset(arr), byteOffset, 'new ' + typedArray + '(new ArrayBuffer(' + length + '), ' + byteOffset + ') is typed array of byte offset ' + byteOffset);
+		} else {
+			t.comment('# SKIP ' + typedArray + ' is not supported');
+		}
+	});
+	t.end();
+});