ff6d873143354a2b18b1fbf58ffb58e2743392dbf8326e5f431f84d326e71852164a122ebb8f11fbabc15964ef63e0558b59d1ccc83a7581573fa6937aa900 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. # typed-array-byte-offset <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
  2. [![github actions][actions-image]][actions-url]
  3. [![coverage][codecov-image]][codecov-url]
  4. [![License][license-image]][license-url]
  5. [![Downloads][downloads-image]][downloads-url]
  6. [![npm badge][npm-badge-png]][package-url]
  7. 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.
  8. ## Example
  9. ```js
  10. var typedArrayByteOffset = require('typed-array-byte-offset');
  11. var assert = require('assert');
  12. assert.equal(false, typedArrayByteOffset(undefined));
  13. assert.equal(false, typedArrayByteOffset(null));
  14. assert.equal(false, typedArrayByteOffset(false));
  15. assert.equal(false, typedArrayByteOffset(true));
  16. assert.equal(false, typedArrayByteOffset([]));
  17. assert.equal(false, typedArrayByteOffset({}));
  18. assert.equal(false, typedArrayByteOffset(/a/g));
  19. assert.equal(false, typedArrayByteOffset(new RegExp('a', 'g')));
  20. assert.equal(false, typedArrayByteOffset(new Date()));
  21. assert.equal(false, typedArrayByteOffset(42));
  22. assert.equal(false, typedArrayByteOffset(NaN));
  23. assert.equal(false, typedArrayByteOffset(Infinity));
  24. assert.equal(false, typedArrayByteOffset(new Number(42)));
  25. assert.equal(false, typedArrayByteOffset('foo'));
  26. assert.equal(false, typedArrayByteOffset(Object('foo')));
  27. assert.equal(false, typedArrayByteOffset(function () {}));
  28. assert.equal(false, typedArrayByteOffset(function* () {}));
  29. assert.equal(false, typedArrayByteOffset(x => x * x));
  30. assert.equal(false, typedArrayByteOffset([]));
  31. const buffer = new ArrayBuffer(32);
  32. assert.equal(8, typedArrayByteOffset(new Int8Array(buffer, 8)));
  33. assert.equal(8, typedArrayByteOffset(new Uint8Array(buffer, 8)));
  34. assert.equal(8, typedArrayByteOffset(new Uint8ClampedArray(buffer, 8)));
  35. assert.equal(4, typedArrayByteOffset(new Int16Array(buffer, 4)));
  36. assert.equal(4, typedArrayByteOffset(new Uint16Array(buffer, 4)));
  37. assert.equal(8, typedArrayByteOffset(new Int32Array(buffer, 8)));
  38. assert.equal(8, typedArrayByteOffset(new Uint32Array(buffer, 8)));
  39. assert.equal(16, typedArrayByteOffset(new Float32Array(buffer, 16)));
  40. assert.equal(16, typedArrayByteOffset(new Float64Array(buffer, 16)));
  41. assert.equal(16, typedArrayByteOffset(new BigInt64Array(buffer, 16)));
  42. assert.equal(16, typedArrayByteOffset(new BigUint64Array(buffer, 16)));
  43. ```
  44. ## Tests
  45. Simply clone the repo, `npm install`, and run `npm test`
  46. [package-url]: https://npmjs.org/package/typed-array-byte-offset
  47. [npm-version-svg]: https://versionbadg.es/inspect-js/typed-array-byte-offset.svg
  48. [deps-svg]: https://david-dm.org/inspect-js/typed-array-byte-offset.svg
  49. [deps-url]: https://david-dm.org/inspect-js/typed-array-byte-offset
  50. [dev-deps-svg]: https://david-dm.org/inspect-js/typed-array-byte-offset/dev-status.svg
  51. [dev-deps-url]: https://david-dm.org/inspect-js/typed-array-byte-offset#info=devDependencies
  52. [npm-badge-png]: https://nodei.co/npm/typed-array-byte-offset.png?downloads=true&stars=true
  53. [license-image]: https://img.shields.io/npm/l/typed-array-byte-offset.svg
  54. [license-url]: LICENSE
  55. [downloads-image]: https://img.shields.io/npm/dm/typed-array-byte-offset.svg
  56. [downloads-url]: https://npm-stat.com/charts.html?package=typed-array-byte-offset
  57. [codecov-image]: https://codecov.io/gh/inspect-js/typed-array-byte-offset/branch/main/graphs/badge.svg
  58. [codecov-url]: https://app.codecov.io/gh/inspect-js/typed-array-byte-offset/
  59. [actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/typed-array-byte-offset
  60. [actions-url]: https://github.com/inspect-js/typed-array-byte-offset/actions