securityos/node_modules/data-view-byte-offset/README.md

44 lines
2.0 KiB
Markdown

# data-view-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]
Get the `byteOffset` out of a DataView, robustly.
This will work in node <= 0.10 and < 0.11.4, where there's no prototype accessor, only a nonconfigurable own property.
It will also work in modern engines where `DataView.prototype.byteOffset` has been deleted after this module has loaded.
## Example
```js
const dataViewByteOffset = require('data-view-byte-offset');
const assert = require('assert');
const ab = new ArrayBuffer(42);
const dv = new DataView(ab, 2);
assert.equal(dataViewByteOffset(dv), 2);
```
## Tests
Simply clone the repo, `npm install`, and run `npm test`
[package-url]: https://npmjs.org/package/data-view-byte-offset
[npm-version-svg]: https://versionbadg.es/ljharb/data-view-byte-offset.svg
[deps-svg]: https://david-dm.org/ljharb/data-view-byte-offset.svg
[deps-url]: https://david-dm.org/ljharb/data-view-byte-offset
[dev-deps-svg]: https://david-dm.org/ljharb/data-view-byte-offset/dev-status.svg
[dev-deps-url]: https://david-dm.org/ljharb/data-view-byte-offset#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/data-view-byte-offset.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/data-view-byte-offset.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/data-view-byte-offset.svg
[downloads-url]: https://npm-stat.com/charts.html?package=data-view-byte-offset
[codecov-image]: https://codecov.io/gh/ljharb/data-view-byte-offset/branch/main/graphs/badge.svg
[codecov-url]: https://app.codecov.io/gh/ljharb/data-view-byte-offset/
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/data-view-byte-offset
[actions-url]: https://github.com/ljharb/data-view-byte-offset/actions