|
1 |
| - |
| 1 | + |
2 | 2 | ======================================
|
3 |
| -ByteBuffer.js provides a full-featured and highly optimized ByteBuffer implementation in JavaScript, since version 3 |
4 |
| -either backed by an ArrayBuffer for browser environments (ByteBufferAB) or, alternatively, a node Buffer (ByteBufferNB) |
5 |
| -to make use of the performance benefits when running under node.js. Both versions are API-compatible and generated from |
6 |
| -a single source tree using [MetaScript](https://github.com/dcodeIO/MetaScript). |
| 3 | +A fast and complete ByteBuffer implementation using either ArrayBuffers in the browser or node Buffers under node.js, |
| 4 | +generated from a single source tree through [MetaScript](https://github.com/dcodeIO/MetaScript). |
7 | 5 |
|
8 | 6 | If you are looking for ByteBuffer.js 2, [that's the branch](https://github.com/dcodeIO/ByteBuffer.js/tree/ByteBuffer2).
|
9 | 7 |
|
10 |
| -**Please note**: Though all old and new test cases are passing, ByteBuffer.js 3 still needs to be tested in real world |
11 |
| -scenarios. Also, the API has changed a bit to make things more straight forward. |
12 |
| - |
13 | 8 | What can it do?
|
14 | 9 | ---------------
|
15 |
| -* Mimics Java ByteBuffers as close as reasonable while using typed array terms |
16 | 10 | * 8, 16, 32 and 64 bit signed and unsigned integers
|
17 | 11 | * 32 and 64 bit floats
|
18 | 12 | * Big and little endianness
|
19 |
| -* Variable length integers as used in protobuf (32 and 64 bit, including zig zag encoding) |
| 13 | +* Varints as used in protobuf (32 and 64 bit, zig-zag) |
20 | 14 | * Base64, binary, debug, hex and utf8 encodings
|
21 | 15 | * Handy string and debugging utilities
|
22 | 16 | * Relative and absolute zero-copy operations wherever possible
|
23 |
| -* Manual and automatic resizing (efficiently doubles capacity) |
| 17 | +* Transparent resizing when using unknown-length data |
24 | 18 | * Chaining of all operations that do not return a specific value
|
25 | 19 | * Slicing, appending, prepending, reversing, flip, mark, reset, etc.
|
26 | 20 |
|
@@ -89,7 +83,7 @@ Downloads
|
89 | 83 |
|
90 | 84 | Documentation
|
91 | 85 | -------------
|
92 |
| -* [View the API documentation](http://htmlpreview.github.com/?http://github.com/dcodeIO/ByteBuffer.js/master/docs/ByteBuffer.html) |
| 86 | +* [View the API documentation](http://htmlpreview.github.com/?http://github.com/dcodeIO/ByteBuffer.js/master/docs/module-ByteBuffer.html) |
93 | 87 |
|
94 | 88 | Tests (& Examples) [](https://travis-ci.org/dcodeIO/ByteBuffer.js)
|
95 | 89 | ------------------
|
|
0 commit comments