florianwendelborn / bitwise Goto Github PK

View Code? Open in Web Editor NEW

80.0 2.0 8.0 53.92 MB

:keycap_ten: JavaScript/TypeScript library to manipulate bits, nibbles, bytes, and buffers.

Home Page: https://npmjs.org/package/bitwise

License: MIT License

TypeScript 100.00%

npm-package bitwise bit-manipulation bits byte nibble buffer

bitwise's Issues

did you remove .toBits?

while upgrading packages in my utility library it throws error for missing .toBits function.
can you please put it back. Thx

https://github.com/dodekeract/bitwise/tree/master/source/bits

Smart "Convert To" Function

Figures out if input is string, integer, buffer, bits and converts them.

bitwise.convert([0,0,1,0,1,0,1,0], 'byte') === 42
bitwise.convert(Buffer<42>, 'byte') === 42

Fix JSDoc @param

Some JSDoc @param declarations use invalid syntax.

Add integer.addBit, integer.removeBit and improve integer.setBit, integer.toggleBit, integer.getBit

Hello, integer.addBit and integer.removeBit methods should be added to the library.

An implementation could look like this:

add-bit.ts

export default (int32: number, position: number): number => int32 | (1 << position)

remove-bit.ts

export default (int32: number, position: number): number => int32 & ~(1 << position)

Also integer.setBit, integer.toggleBit and integer.getBit functions could be improved:

set-bit.ts

// Current.
export default (int32: number, position: number, value: Bit): Bit =>
	<Bit>(value === 1 ? int32 | (1 << position) : int32 & ~(1 << position))

// Proposed. The return type should be number, not Bit.
export default (int32: number, position: number, value: Bit): number =>
	(value === 1 ? int32 | (1 << position) : int32 & ~(1 << position))

// Proposed. Would be nice if we could pass a boolean to setBit.
export default (int32: number, position: number, value: Bit | boolean): number =>
	(!!value ? int32 | (1 << position) : int32 & ~(1 << position))

toggle-bit.ts

// Current.
export default (int32: number, position: number) => int32 ^ (1 << position)

// Proposed. The return type should be specified.
export default (int32: number, position: number): number => int32 ^ (1 << position)

get-bit.ts

// Current.
export default (int32: number, position: number): Bit =>
	<Bit>((int32 >> position) & 1)

// Proposed. Unsigned right shift should be used.
export default (int32: number, position: number): Bit =>
	<Bit>((int32 >>> position) & 1)

help with reading binary data from buffer

I have this question on SO:

http://stackoverflow.com/questions/41715421/read-binary-data-from-buffer

I am wondering if this library can help. pretty unsure of how to proceed.

Improve Buffer Handling

new Buffer(size) is deprecated. It should be replaced with Buffer.alloc(size).

bitwise.byte.read(17) => Cannot read property 'read' of undefined

I had used to be happy with bitwise but this code doesn't work anymore.

const bitwise = require('bitwise')

let binFlags = bitwise.byte.read(17)

console.log(binFlags)

let binFlags = bitwise.byte.read(17)
                           ^

TypeError: Cannot read property 'read' of undefined

I've used to use readByte from version < 1.0.0 but this function disappeared.

Extend Operation Functionality

Can you please implement bit shift operations like logical shift, arithmetic shift and cyclic shift ?

Logical Shift (#45 — currently stuck)
Arithmetic Shift (#47 — currently stuck)
Cyclic Shift (#49)

Fix Naming

Currently, bitwise.(buffer|byte).(read|write) use inconsistent naming. It should be converted to bitwise.(integer|bits).to(Buffer|Byte) etc..

florianwendelborn / bitwise Goto Github PK

bitwise's Issues

did you remove .toBits?

Smart "Convert To" Function

Fix JSDoc @param

Add integer.addBit, integer.removeBit and improve integer.setBit, integer.toggleBit, integer.getBit

help with reading binary data from buffer

Improve Buffer Handling

bitwise.byte.read(17) => Cannot read property 'read' of undefined

Extend Operation Functionality

Fix Naming

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent