https://github.com/explore-node-js/node.js-bytes-calculator
abstracted byte sequence calculator for node.js
https://github.com/explore-node-js/node.js-bytes-calculator
abstraction bitwise bitwise-operators calculator javascript nodejs npm-package
Last synced: about 1 year ago
JSON representation
abstracted byte sequence calculator for node.js
- Host: GitHub
- URL: https://github.com/explore-node-js/node.js-bytes-calculator
- Owner: explore-node-js
- License: mit
- Created: 2017-03-05T15:06:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-05-03T15:32:50.000Z (about 7 years ago)
- Last Synced: 2025-03-07T19:38:45.224Z (over 1 year ago)
- Topics: abstraction, bitwise, bitwise-operators, calculator, javascript, nodejs, npm-package
- Language: JavaScript
- Homepage:
- Size: 58.6 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[ci.tests-master-badge]: https://circleci.com/gh/explore-node-js/node.js-bytes-calculator/tree/master.svg?style=svg
[ci.tests-master]: https://circleci.com/gh/explore-node-js/node.js-bytes-calculator/tree/master
[ci.coverage-master-badge]: https://codecov.io/gh/explore-node-js/node.js-bytes-calculator/branch/master/graph/badge.svg
[ci.coverage-master]: https://codecov.io/gh/explore-node-js/node.js-bytes-calculator
[npm.package-badge]: https://badge.fury.io/js/byte-sequence-calculator.svg
[npm.package]: https://www.npmjs.com/package/byte-sequence-calculator
# sequence-calculator
abstract and easy way how to work with byte sequences in JS
[![build][ci.tests-master-badge]][ci.tests-master]
[![coverage][ci.coverage-master-badge]][ci.coverage-master]
[![coverage][npm.package-badge]][npm.package]
### how to install
`$ npm i sequence-calculator` or `yarn add sequence-calculator`
### software requirements
* [node.js](https://nodejs.org/)
* [npm](https://www.npmjs.com/)+ or [yarn](https://yarnpkg.com/)
### used technologies
* [jest](https://facebook.github.io/jest/) - only for tests
### used services
* [circle ci](https://circleci.com/dashboard)
* [codecov](https://codecov.io/)
* [code climate](https://codeclimate.com/)
* [snyk](https://snyk.io/)
### how to execute tests
* `$ npm test`
* to execute tests with coverage `npm test -- --coverage`
### how to use
```javascript
/** ES6 */
import { hasSequence, addSequence, removeSequence } from 'sequence-calculator';
/** commmonjs */
const { hasSequence, addSequence, removeSequence } = require('sequence-calculator');
/** examples */
hasSequence(255, 0x0f) -> returns true {true}, as 0xFF {255} contains 0xF {15}
hasSequence(0b10, 0o10) -> returns false {false}, as 0x02 {2} do not contains 0x08 {8}
addSequence(0x02, 0x02) -> returns 0x02 {2}, as sequence 0x02 {2} already contains 0x01 {2}
addSequence(0o01, 0b10) -> returns 0x03 {3}, as sequence 0x01 {1} do not contain 0x02 {2}
removeSequence(0x00, 0x01) -> returns 0x00 {0}, as 0x01 {1} is not present in 0x0 {0}
removeSequence(0o06, 2) -> returns 0x04 {4}, as 0x02 {2} been dropped 0x06 {6} sequence
removeSequence(2, 0b110) -> returns 0x00 {0}, as 0x06 {6} sequence contained 0x02 {2},
which been removed from origin 0x02
```