10000 Type annotations for CC · adon-at-work/bytebuffer.js@89f84e8 · GitHub
[go: up one dir, main page]
Skip to content

Commit 89f84e8

Browse files
dcodeIOdcodeIO
committed
Type annotations for CC
1 parent cc9d7e4 commit 89f84e8

File tree

6 files changed

+43
-3
lines changed

6 files changed

+43
-3
lines changed

‎dist/ByteBufferAB.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,6 +1151,16 @@
11511151
THE SOFTWARE.
11521152
*/
11531153

1154+
/**
1155+
* Reads an IEEE754 float from an array.
1156+
* @param {!Array} buffer
1157+
* @param {number} offset
1158+
* @param {boolean} isLE
1159+
* @param {number} mLen
1160+
* @param {number} nBytes
1161+
* @returns {number}
1162+
* @inner
1163+
*/
11541164
function ieee754_read(buffer, offset, isLE, mLen, nBytes) {
11551165
var e, m,
11561166
eLen = nBytes * 8 - mLen - 1,
@@ -1184,6 +1194,16 @@
11841194
return (s ? -1 : 1) * m * Math.pow(2, e - mLen);
11851195
}
11861196

1197+
/**
1198+
* Writes an IEEE754 float to an array.
1199+
* @param {!Array} buffer
1200+
* @param {number} value
1201+
* @param {number} offset
1202+
* @param {boolean} isLE
1203+
* @param {number} mLen
1204+
* @param {number} nBytes
1205+
* @inner
1206+
*/
11871207
function ieee754_write(buffer, value, offset, isLE, mLen, nBytes) {
11881208
var e, m, c,
11891209
eLen = nBytes * 8 - mLen - 1,

‎dist/ByteBufferAB.min.js.gz

0 Bytes
Binary file not shown.

‎dist/ByteBufferAB.min.map

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎dist/ByteBufferAB_DataView.min.js.gz

0 Bytes
Binary file not shown.

‎dist/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Distributions
22
=============
33

4-
ByteBuffer uses either ArrayBuffers in the browser or Buffers under node.js.
4+
ByteBuffer.js uses either ArrayBuffers in the browser or Buffers under node.js.
55

66
### Browser: [ArrayBuffer](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)-backed
77

@@ -24,7 +24,7 @@ Using Typed Arrays here is pretty much ideal, but it [requires a somewhat recent
2424
##### Accessed through a DataView ([polyfill](https://github.com/inexorabletash/polyfill/blob/master/typedarray.js) compatible)
2525

2626
Using DataViews is [generally slower](https://github.com/dcodeIO/ByteBuffer.js/issues/16) but works well with common polyfills for
27-
older browsers, as it does not utilize array access operators on Typed Arrays.
27+
older browsers (avoids array access operators on Typed Arrays).
2828

2929
* **[ByteBufferAB_DataView.js](https://raw.githubusercontent.com/dcodeIO/ByteBuffer.js/master/dist/ByteBufferAB_DataView.js)**
3030
uses an ArrayBuffer as its backing buffer, accessed through a [DataView](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/DataView).

‎src/types/floats/ieee754.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,16 @@
2424
THE SOFTWARE.
2525
*/
2626

27+
/**
28+
* Reads an IEEE754 float from an array.
29+
* @param {!Array} buffer
30+
* @param {number} offset
31+
* @param {boolean} isLE
32+
* @param {number} mLen
33+
* @param {number} nBytes
34+
* @returns {number}
35+
* @inner
36+
*/
2737
function ieee754_read(buffer, offset, isLE, mLen, nBytes) {
2838
var e, m,
2939
eLen = nBytes * 8 - mLen - 1,
@@ -57,6 +67,16 @@ function ieee754_read(buffer, offset, isLE, mLen, nBytes) {
5767
return (s ? -1 : 1) * m * Math.pow(2, e - mLen);
5868
}
5969

70+
/**
71+
* Writes an IEEE754 float to an array.
72+
* @param {!Array} buffer
73+
* @param {number} value
74+
* @param {number} offset
75+
* @param {boolean} isLE
76+
* @param {number} mLen
77+
* @param {number} nBytes
78+
* @inner
79+
*/
6080
function ieee754_write(buffer, value, offset, isLE, mLen, nBytes) {
6181
var e, m, c,
6282
eLen = nBytes * 8 - mLen - 1,

0 commit comments

Comments
 (0)
0