bireader 1.0.26 → 1.0.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3319 +0,0 @@
1
- /// <reference types="node" />
2
- /**
3
- * Binary reader, includes bitfields and strings
4
- *
5
- * @param {Buffer|Uint8Array} data - ```Buffer``` or ```Uint8Array```. Always found in ``biwriter.data``
6
- * @param {number} byteOffset - Byte offset to start reader (default 0)
7
- * @param {number} bitOffset - Bit offset 0-7 to start reader (default 0)
8
- * @param {string} endianness - Endianness ```big``` or ```little``` (default ```little```)
9
- * @param {boolean} strict - Strict mode: if true does not extend supplied array on outside write (default true)
10
- */
11
- export declare class bireader {
12
- endian: string;
13
- offset: number;
14
- bitoffset: number;
15
- size: number;
16
- strict: boolean;
17
- errorDump: boolean;
18
- data: any;
19
- private isBufferOrUint8Array;
20
- extendArray(to_padd: number): void;
21
- /**
22
- * Binary reader, includes bitfields and strings
23
- *
24
- * @param {Buffer|Uint8Array} data - ```Buffer``` or ```Uint8Array```. Always found in ``biwriter.data``
25
- * @param {number} byteOffset - Byte offset to start reader (default 0)
26
- * @param {number} bitOffset - Bit offset 0-7 to start reader (default 0)
27
- * @param {string} endianness - Endianness ```big``` or ```little``` (default ```little```)
28
- * @param {boolean} strict - Strict mode: if true does not extend supplied array on outside write (default true)
29
- */
30
- constructor(data: Array<Buffer | Uint8Array>, byteOffset?: number, bitOffset?: number, endianness?: string, strict?: boolean);
31
- /**
32
- *
33
- * Change endian, defaults to little
34
- *
35
- * Can be changed at any time, doesn't loose position
36
- *
37
- * @param {string} endian - endianness ```big``` or ```little```
38
- */
39
- endianness(endian: string): void;
40
- /**
41
- *Sets endian to big
42
- */
43
- bigEndian(): void;
44
- /**
45
- *Sets endian to big
46
- */
47
- big(): void;
48
- /**
49
- *Sets endian to big
50
- */
51
- be(): void;
52
- /**
53
- * Sets endian to little
54
- */
55
- littleEndian(): void;
56
- /**
57
- * Sets endian to little
58
- */
59
- little(): void;
60
- /**
61
- * Sets endian to little
62
- */
63
- le(): void;
64
- /**
65
- * Offset current byte or bit position
66
- * Note: Will extend array if strict mode is off and outside of max size
67
- *
68
- * @param {number} bytes - Bytes to skip
69
- * @param {number} bits - Bits to skip (0-7)
70
- */
71
- skip(bytes: number, bits?: number): void;
72
- /**
73
- * Offset current byte or bit position
74
- * Note: Will extend array if strict mode is off and outside of max size
75
- *
76
- * @param {number} bytes - Bytes to skip
77
- * @param {number} bits - Bits to skip (0-7)
78
- */
79
- jump(bytes: number, bits?: number): void;
80
- /**
81
- * Change position directly to address
82
- * Note: Will extend array if strict mode is off and outside of max size
83
- *
84
- * @param {number} byte - byte to set to
85
- * @param {number} bit - bit to set to (0-7)
86
- */
87
- goto(byte: number, bit?: number): void;
88
- /**
89
- * Offset current byte or bit position
90
- * Note: Will extend array if strict mode is off and outside of max size
91
- *
92
- * @param {number} bytes - Bytes to skip
93
- * @param {number} bits - Bits to skip (0-7)
94
- */
95
- seek(bytes: number, bits?: number): void;
96
- /**
97
- * Change position directly to address
98
- * Note: Will extend array if strict mode is off and outside of max size
99
- *
100
- * @param {number} byte - byte to set to
101
- * @param {number} bit - bit to set to (0-7)
102
- */
103
- pointer(byte: number, bit?: number): void;
104
- /**
105
- * Change position directly to address
106
- * Note: Will extend array if strict mode is off and outside of max size
107
- *
108
- * @param {number} byte - byte to set to
109
- * @param {number} bit - bit to set to (0-7)
110
- */
111
- warp(byte: number, bit?: number): void;
112
- /**
113
- * Set byte and bit position to start of data
114
- */
115
- rewind(): void;
116
- /**
117
- * Set byte and bit position to start of data
118
- */
119
- gotostart(): void;
120
- /**
121
- * Get the current byte position
122
- *
123
- * @return {number} current byte position
124
- */
125
- tell(): number;
126
- /**
127
- * Get the current byte position
128
- *
129
- * @return {number} current byte position
130
- */
131
- getOffset(): number;
132
- /**
133
- * Get the current byte position
134
- *
135
- * @return {number} current byte position
136
- */
137
- saveOffset(): number;
138
- /**
139
- * Get the current bit position (0-7)
140
- *
141
- * @return {number} current bit position
142
- */
143
- tellB(): number;
144
- /**
145
- * Get the current bit position (0-7)
146
- *
147
- * @return {number} current bit position
148
- */
149
- getOffsetBit(): number;
150
- /**
151
- * Get the current bit position (0-7)
152
- *
153
- * @return {number} current bit position
154
- */
155
- saveOffsetAbsBit(): number;
156
- /**
157
- * Get the current absolute bit position (from start of data)
158
- *
159
- * @return {number} current absolute bit position
160
- */
161
- tellAbsB(): number;
162
- /**
163
- * Get the current absolute bit position (from start of data)
164
- *
165
- * @return {number} current absolute bit position
166
- */
167
- getOffsetAbsBit(): number;
168
- /**
169
- * Get the current absolute bit position (from start of data)
170
- *
171
- * @return {number} current absolute bit position
172
- */
173
- saveOffsetBit(): number;
174
- /**
175
- * Disallows extending data if position is outside of max size
176
- */
177
- restrict(): void;
178
- /**
179
- * Allows extending data if position is outside of max size
180
- */
181
- unrestrict(): void;
182
- /**
183
- * XOR data
184
- *
185
- * @param {number|string|Uint8Array|Buffer} xorKey - Value, string or array to XOR
186
- * @param {number} startOffset - Start location (default current byte position)
187
- * @param {number} endOffset - End location (default end of data)
188
- * @param {boolean} consume - Move current position to end of data (default false)
189
- */
190
- xor(xorKey: number | string | Uint8Array | Buffer, startOffset?: number, endOffset?: number, consume?: boolean): void;
191
- /**
192
- * XOR data
193
- *
194
- * @param {number|string|Uint8Array|Buffer} xorKey - Value, string or array to XOR
195
- * @param {number} length - Length in bytes to XOR from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
196
- * @param {boolean} consume - Move current position to end of data (default false)
197
- */
198
- xorThis(xorKey: number | string | Uint8Array | Buffer, length?: number, consume?: boolean): void;
199
- /**
200
- * OR data
201
- *
202
- * @param {number|string|Uint8Array|Buffer} orKey - Value, string or array to OR
203
- * @param {number} startOffset - Start location (default current byte position)
204
- * @param {number} endOffset - End location (default end of data)
205
- * @param {boolean} consume - Move current position to end of data (default false)
206
- */
207
- or(orKey: number | string | Uint8Array | Buffer, startOffset?: number, endOffset?: number, consume?: boolean): void;
208
- /**
209
- * OR data
210
- *
211
- * @param {number|string|Uint8Array|Buffer} orKey - Value, string or array to OR
212
- * @param {number} length - Length in bytes to OR from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
213
- * @param {boolean} consume - Move current position to end of data (default false)
214
- */
215
- orThis(orKey: number | string | Uint8Array | Buffer, length?: number, consume?: boolean): void;
216
- /**
217
- * AND data
218
- *
219
- * @param {number|string|Array<number>|Buffer} andKey - Value, string or array to AND
220
- * @param {number} startOffset - Start location (default current byte position)
221
- * @param {number} endOffset - End location (default end of data)
222
- * @param {boolean} consume - Move current position to end of data (default false)
223
- */
224
- and(andKey: number | string | Array<number> | Buffer, startOffset?: number, endOffset?: number, consume?: boolean): void;
225
- /**
226
- * AND data
227
- *
228
- * @param {number|string|Array<number>|Buffer} andKey - Value, string or array to AND
229
- * @param {number} length - Length in bytes to AND from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
230
- * @param {boolean} consume - Move current position to end of data (default false)
231
- */
232
- andThis(andKey: number | string | Array<number> | Buffer, length?: number, consume?: boolean): void;
233
- /**
234
- * Not data
235
- *
236
- * @param {number} startOffset - Start location (default current byte position)
237
- * @param {number} endOffset - End location (default end of data)
238
- * @param {boolean} consume - Move current position to end of data (default false)
239
- */
240
- not(startOffset?: number, endOffset?: number, consume?: boolean): void;
241
- /**
242
- * Not data
243
- *
244
- * @param {number} length - Length in bytes to NOT from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
245
- * @param {boolean} consume - Move current position to end of data (default false)
246
- */
247
- notThis(length?: number, consume?: boolean): void;
248
- /**
249
- * Left shift data
250
- *
251
- * @param {number|string|Array<number>|Buffer} shiftKey - Value, string or array to left shift data
252
- * @param {number} startOffset - Start location (default current byte position)
253
- * @param {number} endOffset - End location (default end of data)
254
- * @param {boolean} consume - Move current position to end of data (default false)
255
- */
256
- lShift(shiftKey: number | string | Array<number> | Buffer, startOffset?: number, endOffset?: number, consume?: boolean): void;
257
- /**
258
- * Left shift data
259
- *
260
- * @param {number|string|Array<number>|Buffer} shiftKey - Value, string or array to left shift data
261
- * @param {number} length - Length in bytes to left shift from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
262
- * @param {boolean} consume - Move current position to end of data (default false)
263
- */
264
- lShiftThis(shiftKey: number | string | Array<number> | Buffer, length?: number, consume?: boolean): void;
265
- /**
266
- * Right shift data
267
- *
268
- * @param {number|string|Array<number>|Buffer} shiftKey - Value, string or array to right shift data
269
- * @param {number} startOffset - Start location (default current byte position)
270
- * @param {number} endOffset - End location (default end of data)
271
- * @param {boolean} consume - Move current position to end of data (default false)
272
- */
273
- rShift(shiftKey: number | string | Array<number> | Buffer, startOffset?: number, endOffset?: number, consume?: boolean): void;
274
- /**
275
- * Right shift data
276
- *
277
- * @param {number|string|Array<number>|Buffer} shiftKey - Value, string or array to right shift data
278
- * @param {number} length - Length in bytes to right shift from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
279
- * @param {boolean} consume - Move current position to end of data (default false)
280
- */
281
- rShiftThis(shiftKey: number | string | Array<number> | Buffer, length?: number, consume?: boolean): void;
282
- /**
283
- * Add value to data
284
- *
285
- * @param {number|string|Array<number>|Buffer} addKey - Value, string or array to add to data
286
- * @param {number} startOffset - Start location (default current byte position)
287
- * @param {number} endOffset - End location (default end of data)
288
- * @param {boolean} consume - Move current position to end of data (default false)
289
- */
290
- add(addKey: number | string | Array<number> | Buffer, startOffset?: number, endOffset?: number, consume?: boolean): void;
291
- /**
292
- * Add value to data
293
- *
294
- * @param {number|string|Array<number>|Buffer} addKey - Value, string or array to add to data
295
- * @param {number} length - Length in bytes to add from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
296
- * @param {boolean} consume - Move current position to end of data (default false)
297
- */
298
- addThis(addKey: number | string | Array<number> | Buffer, length?: number, consume?: boolean): void;
299
- /**
300
- * Deletes part of data from start to current byte position unless supplied, returns removed
301
- * Note: Errors in strict mode
302
- *
303
- * @param {number} startOffset - Start location (default 0)
304
- * @param {number} endOffset - End location (default current position)
305
- * @param {boolean} consume - Move position to end of removed data (default false)
306
- * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
307
- */
308
- delete(startOffset?: number, endOffset?: number, consume?: boolean): Array<Buffer | Uint8Array>;
309
- /**
310
- * Deletes part of data from current byte position to end, returns removed
311
- * Note: Errors in strict mode
312
- *
313
- * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
314
- */
315
- clip(): Array<Buffer | Uint8Array>;
316
- /**
317
- * Deletes part of data from current byte position to end, returns removed
318
- * Note: Errors in strict mode
319
- *
320
- * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
321
- */
322
- trim(): Array<Buffer | Uint8Array>;
323
- /**
324
- * Deletes part of data from current byte position to supplied length, returns removed
325
- * Note: Errors in strict mode
326
- *
327
- * @param {number} length - Length of data in bytes to remove
328
- * @param {boolean} consume - Move position to end of removed data (default false)
329
- * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
330
- */
331
- crop(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
332
- /**
333
- * Deletes part of data from current position to supplied length, returns removed
334
- * Note: Only works in strict mode
335
- *
336
- * @param {number} length - Length of data in bytes to remove
337
- * @param {boolean} consume - Move position to end of removed data (default false)
338
- * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
339
- */
340
- drop(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
341
- /**
342
- * Returns part of data from current byte position to end of data unless supplied
343
- *
344
- * @param {number} startOffset - Start location (default current position)
345
- * @param {number} endOffset - End location (default end of data)
346
- * @param {boolean} consume - Move position to end of lifted data (default false)
347
- * @param {number} fillValue - Byte value to to fill returned data (does NOT fill unless supplied)
348
- * @returns {Buffer|Uint8Array} Selected data as ```Uint8Array``` or ```Buffer```
349
- */
350
- lift(startOffset?: number, endOffset?: number, consume?: boolean, fillValue?: number): Array<Buffer | Uint8Array>;
351
- /**
352
- * Returns part of data from current byte position to end of data unless supplied
353
- *
354
- * @param {number} startOffset - Start location (default current position)
355
- * @param {number} endOffset - End location (default end of data)
356
- * @param {boolean} consume - Move position to end of lifted data (default false)
357
- * @param {number} fillValue - Byte value to to fill returned data (does NOT fill unless supplied)
358
- * @returns {Buffer|Uint8Array} Selected data as ```Uint8Array``` or ```Buffer```
359
- */
360
- fill(startOffset?: number, endOffset?: number, consume?: boolean, fillValue?: number): Array<Buffer | Uint8Array>;
361
- /**
362
- * Extract data from current position to length supplied
363
- * Note: Does not affect supplied data
364
- *
365
- * @param {number} length - Length of data in bytes to copy from current offset
366
- * @param {number} consume - Moves offset to end of length
367
- * @returns {Buffer|Uint8Array} Selected data as ```Uint8Array``` or ```Buffer```
368
- */
369
- extract(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
370
- /**
371
- * Extract data from current position to length supplied
372
- * Note: Does not affect supplied data
373
- *
374
- * @param {number} length - Length of data in bytes to copy from current offset
375
- * @param {number} consume - Moves offset to end of length
376
- * @returns {Buffer|Uint8Array} Selected data as ```Uint8Array``` or ```Buffer```
377
- */
378
- slice(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
379
- /**
380
- * Extract data from current position to length supplied
381
- * Note: Does not affect supplied data
382
- *
383
- * @param {number} length - Length of data in bytes to copy from current offset
384
- * @param {number} consume - Moves offset to end of length
385
- * @returns {Buffer|Uint8Array} Selected data as ```Uint8Array``` or ```Buffer```
386
- */
387
- wrap(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
388
- /**
389
- * Inserts data into data
390
- * Note: Must be same data type as supplied data. Errors on strict mode.
391
- *
392
- * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
393
- * @param {boolean} consume - Move current byte position to end of data (default false)
394
- * @param {number} offset - Byte position to add at (defaults to current position)
395
- */
396
- insert(data: Buffer | Uint8Array, consume?: boolean, offset?: number): void;
397
- /**
398
- * Inserts data into data
399
- * Note: Must be same data type as supplied data. Errors on strict mode.
400
- *
401
- * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
402
- * @param {boolean} consume - Move current byte position to end of data (default false)
403
- * @param {number} offset - Byte position to add at (defaults to current position)
404
- */
405
- place(data: Buffer | Uint8Array, consume?: boolean, offset?: number): void;
406
- /**
407
- * Replaces data in data
408
- * Note: Must be same data type as supplied data. Errors on strict mode.
409
- *
410
- * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to replace in data
411
- * @param {boolean} consume - Move current byte position to end of data (default false)
412
- * @param {number} offset - Offset to add it at (defaults to current position)
413
- */
414
- replace(data: Buffer | Uint8Array, consume?: boolean, offset?: number): void;
415
- /**
416
- * Replaces data in data
417
- * Note: Must be same data type as supplied data. Errors on strict mode.
418
- *
419
- * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to replace in data
420
- * @param {boolean} consume - Move current byte position to end of data (default false)
421
- * @param {number} offset - Offset to add it at (defaults to current position)
422
- */
423
- overwrite(data: Buffer | Uint8Array, consume?: boolean, offset?: number): void;
424
- /**
425
- * Adds data to start of supplied data
426
- * Note: Must be same data type as supplied data. Errors on strict mode.
427
- *
428
- * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
429
- * @param {boolean} consume - Move current write position to end of data (default false)
430
- */
431
- unshift(data: Buffer | Uint8Array, consume?: boolean): void;
432
- /**
433
- * Adds data to start of supplied data
434
- * Note: Must be same data type as supplied data. Errors on strict mode.
435
- *
436
- * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
437
- * @param {boolean} consume - Move current write position to end of data (default false)
438
- */
439
- prepend(data: Buffer | Uint8Array, consume?: boolean): void;
440
- /**
441
- * Adds data to end of supplied data
442
- * Note: Must be same data type as supplied data. Errors on strict mode.
443
- *
444
- * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
445
- * @param {boolean} consume - Move current write position to end of data (default false)
446
- */
447
- push(data: Buffer | Uint8Array, consume?: boolean): void;
448
- /**
449
- * Adds data to end of supplied data
450
- * Note: Must be same data type as supplied data. Errors on strict mode.
451
- *
452
- * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
453
- * @param {boolean} consume - Move current write position to end of data (default false)
454
- */
455
- append(data: Buffer | Uint8Array, consume?: boolean): void;
456
- /**
457
- * Returns current data
458
- *
459
- * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
460
- */
461
- get(): Array<Buffer | Uint8Array>;
462
- /**
463
- * Returns current data
464
- *
465
- * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
466
- */
467
- return(): Array<Buffer | Uint8Array>;
468
- /**
469
- * removes data
470
- */
471
- end(): void;
472
- /**
473
- * removes data
474
- */
475
- close(): void;
476
- /**
477
- * removes data
478
- */
479
- done(): void;
480
- /**
481
- * removes data
482
- */
483
- finished(): void;
484
- /**
485
- * Console logs data as hex dump
486
- *
487
- * @param {object} options
488
- * ```javascript
489
- * {
490
- * length: 192, // number of bytes to log, default 192 or end of data
491
- * startByte: 0, // byte to start dump (default current byte position)
492
- * supressUnicode: false // Supress unicode character preview for even columns
493
- * }
494
- * ```
495
- */
496
- hexdump(options?: {
497
- length?: number;
498
- startByte?: number;
499
- supressUnicode?: boolean;
500
- }): void;
501
- /**
502
- * Turn hexdump on error off (default on)
503
- */
504
- errorDumpOff(): void;
505
- /**
506
- * Turn hexdump on error on (default on)
507
- */
508
- errorDumpOn(): void;
509
- /**
510
- *
511
- * Write bits, must have at least value and number of bits
512
- *
513
- * ``Note``: When returning to a byte write, remaining bits are skipped
514
- *
515
- * @param {number} value - value as int
516
- * @param {number} bits - number of bits to write
517
- * @param {boolean} unsigned - if value is unsigned
518
- * @param {string} endian - ``big`` or ``little``
519
- */
520
- writeBit(value: number, bits: number, unsigned?: boolean, endian?: string): void;
521
- /**
522
- * Bit field reader
523
- *
524
- * Note: When returning to a byte read, remaining bits are dropped
525
- *
526
- * @param {number} bits - bits to read
527
- * @param {boolean} unsigned - if the value is unsigned
528
- * @param {string} endian - ``big`` or ``little`
529
- * @returns number
530
- */
531
- readBit(bits?: number, unsigned?: boolean, endian?: string): number;
532
- /**
533
- * Bit field reader
534
- *
535
- * Note: When returning to a byte read, remaining bits are dropped
536
- *
537
- * @param {number} bits - bits to read
538
- * @param {boolean} unsigned - if the value is unsigned
539
- * @param {string} endian - ``big`` or ``little`
540
- * @returns number
541
- */
542
- bit(bits: number, unsigned?: boolean, endian?: string): number;
543
- /**
544
- * Bit field reader
545
- *
546
- * Note: When returning to a byte read, remaining bits are dropped
547
- *
548
- * @param {boolean} unsigned - if the value is unsigned
549
- * @param {string} endian - ``big`` or ``little`
550
- * @returns number
551
- */
552
- bit1(unsigned?: boolean, endian?: string): number;
553
- /**
554
- * Bit field reader
555
- *
556
- * Note: When returning to a byte read, remaining bits are dropped
557
- *
558
- * @param {boolean} unsigned - if the value is unsigned
559
- * @returns number
560
- */
561
- bit1le(unsigned?: boolean): number;
562
- /**
563
- * Bit field reader
564
- *
565
- * Note: When returning to a byte read, remaining bits are dropped
566
- *
567
- * @param {boolean} unsigned - if the value is unsigned
568
- * @returns number
569
- */
570
- bit1be(unsigned?: boolean): number;
571
- /**
572
- * Bit field reader
573
- *
574
- * Note: When returning to a byte read, remaining bits are dropped
575
- *
576
- * @returns number
577
- */
578
- ubit1(): number;
579
- /**
580
- * Bit field reader
581
- *
582
- * Note: When returning to a byte read, remaining bits are dropped
583
- *
584
- * @returns number
585
- */
586
- ubit1le(): number;
587
- /**
588
- * Bit field reader
589
- *
590
- * Note: When returning to a byte read, remaining bits are dropped
591
- *
592
- * @returns number
593
- */
594
- ubit1be(): number;
595
- /**
596
- * Bit field reader
597
- *
598
- * Note: When returning to a byte read, remaining bits are dropped
599
- *
600
- * @param {boolean} unsigned - if the value is unsigned
601
- * @returns number
602
- */
603
- bit2(unsigned?: boolean): number;
604
- /**
605
- * Bit field reader
606
- *
607
- * Note: When returning to a byte read, remaining bits are dropped
608
- *
609
- * @param {boolean} unsigned - if the value is unsigned
610
- * @returns number
611
- */
612
- bit2le(unsigned?: boolean): number;
613
- /**
614
- * Bit field reader
615
- *
616
- * Note: When returning to a byte read, remaining bits are dropped
617
- *
618
- * @param {boolean} unsigned - if the value is unsigned
619
- * @returns number
620
- */
621
- bit2be(unsigned?: boolean): number;
622
- /**
623
- * Bit field reader
624
- *
625
- * Note: When returning to a byte read, remaining bits are dropped
626
- *
627
- * @returns number
628
- */
629
- ubit2(): number;
630
- /**
631
- * Bit field reader
632
- *
633
- * Note: When returning to a byte read, remaining bits are dropped
634
- *
635
- * @returns number
636
- */
637
- ubit2le(): number;
638
- /**
639
- * Bit field reader
640
- *
641
- * Note: When returning to a byte read, remaining bits are dropped
642
- *
643
- * @returns number
644
- */
645
- ubit2be(): number;
646
- /**
647
- * Bit field reader
648
- *
649
- * Note: When returning to a byte read, remaining bits are dropped
650
- *
651
- * @param {boolean} unsigned - if the value is unsigned
652
- * @returns number
653
- */
654
- bit3(unsigned?: boolean): number;
655
- /**
656
- * Bit field reader
657
- *
658
- * Note: When returning to a byte read, remaining bits are dropped
659
- *
660
- * @param {boolean} unsigned - if the value is unsigned
661
- * @returns number
662
- */
663
- bit3le(unsigned?: boolean): number;
664
- /**
665
- * Bit field reader
666
- *
667
- * Note: When returning to a byte read, remaining bits are dropped
668
- *
669
- * @param {boolean} unsigned - if the value is unsigned
670
- * @returns number
671
- */
672
- bit3be(unsigned?: boolean): number;
673
- /**
674
- * Bit field reader
675
- *
676
- * Note: When returning to a byte read, remaining bits are dropped
677
- *
678
- * @returns number
679
- */
680
- ubit3(): number;
681
- /**
682
- * Bit field reader
683
- *
684
- * Note: When returning to a byte read, remaining bits are dropped
685
- *
686
- * @returns number
687
- */
688
- ubit3le(): number;
689
- /**
690
- * Bit field reader
691
- *
692
- * Note: When returning to a byte read, remaining bits are dropped
693
- *
694
- * @returns number
695
- */
696
- ubit3be(): number;
697
- /**
698
- * Bit field reader
699
- *
700
- * Note: When returning to a byte read, remaining bits are dropped
701
- *
702
- * @param {boolean} unsigned - if the value is unsigned
703
- * @returns number
704
- */
705
- bit4(unsigned?: boolean): number;
706
- /**
707
- * Bit field reader
708
- *
709
- * Note: When returning to a byte read, remaining bits are dropped
710
- *
711
- * @param {boolean} unsigned - if the value is unsigned
712
- * @returns number
713
- */
714
- bit4le(unsigned?: boolean): number;
715
- /**
716
- * Bit field reader
717
- *
718
- * Note: When returning to a byte read, remaining bits are dropped
719
- *
720
- * @param {boolean} unsigned - if the value is unsigned
721
- * @returns number
722
- */
723
- bit4be(unsigned?: boolean): number;
724
- /**
725
- * Bit field reader
726
- *
727
- * Note: When returning to a byte read, remaining bits are dropped
728
- *
729
- * @returns number
730
- */
731
- ubit4(): number;
732
- /**
733
- * Bit field reader
734
- *
735
- * Note: When returning to a byte read, remaining bits are dropped
736
- *
737
- * @returns number
738
- */
739
- ubit4le(): number;
740
- /**
741
- * Bit field reader
742
- *
743
- * Note: When returning to a byte read, remaining bits are dropped
744
- *
745
- * @returns number
746
- */
747
- ubit4be(): number;
748
- /**
749
- * Bit field reader
750
- *
751
- * Note: When returning to a byte read, remaining bits are dropped
752
- *
753
- * @param {boolean} unsigned - if the value is unsigned
754
- * @returns number
755
- */
756
- bit5(unsigned?: boolean): number;
757
- /**
758
- * Bit field reader
759
- *
760
- * Note: When returning to a byte read, remaining bits are dropped
761
- *
762
- * @param {boolean} unsigned - if the value is unsigned
763
- * @returns number
764
- */
765
- bit5le(unsigned?: boolean): number;
766
- /**
767
- * Bit field reader
768
- *
769
- * Note: When returning to a byte read, remaining bits are dropped
770
- *
771
- * @param {boolean} unsigned - if the value is unsigned
772
- * @returns number
773
- */
774
- bit5be(unsigned?: boolean): number;
775
- /**
776
- * Bit field reader
777
- *
778
- * Note: When returning to a byte read, remaining bits are dropped
779
- *
780
- * @returns number
781
- */
782
- ubit5(): number;
783
- /**
784
- * Bit field reader
785
- *
786
- * Note: When returning to a byte read, remaining bits are dropped
787
- *
788
- * @returns number
789
- */
790
- ubit5le(): number;
791
- /**
792
- * Bit field reader
793
- *
794
- * Note: When returning to a byte read, remaining bits are dropped
795
- *
796
- * @returns number
797
- */
798
- ubit5be(): number;
799
- /**
800
- * Bit field reader
801
- *
802
- * Note: When returning to a byte read, remaining bits are dropped
803
- *
804
- * @param {boolean} unsigned - if the value is unsigned
805
- * @returns number
806
- */
807
- bit6(unsigned?: boolean): number;
808
- /**
809
- * Bit field reader
810
- *
811
- * Note: When returning to a byte read, remaining bits are dropped
812
- *
813
- * @param {boolean} unsigned - if the value is unsigned
814
- * @returns number
815
- */
816
- bit6le(unsigned?: boolean): number;
817
- /**
818
- * Bit field reader
819
- *
820
- * Note: When returning to a byte read, remaining bits are dropped
821
- *
822
- * @param {boolean} unsigned - if the value is unsigned
823
- * @returns number
824
- */
825
- bit6be(unsigned?: boolean): number;
826
- /**
827
- * Bit field reader
828
- *
829
- * Note: When returning to a byte read, remaining bits are dropped
830
- *
831
- * @returns number
832
- */
833
- ubit6(): number;
834
- /**
835
- * Bit field reader
836
- *
837
- * Note: When returning to a byte read, remaining bits are dropped
838
- *
839
- * @returns number
840
- */
841
- ubit6le(): number;
842
- /**
843
- * Bit field reader
844
- *
845
- * Note: When returning to a byte read, remaining bits are dropped
846
- *
847
- * @returns number
848
- */
849
- ubit6be(): number;
850
- /**
851
- * Bit field reader
852
- *
853
- * Note: When returning to a byte read, remaining bits are dropped
854
- *
855
- * @param {boolean} unsigned - if the value is unsigned
856
- * @returns number
857
- */
858
- bit7(unsigned?: boolean): number;
859
- /**
860
- * Bit field reader
861
- *
862
- * Note: When returning to a byte read, remaining bits are dropped
863
- *
864
- * @param {boolean} unsigned - if the value is unsigned
865
- * @returns number
866
- */
867
- bit7le(unsigned?: boolean): number;
868
- /**
869
- * Bit field reader
870
- *
871
- * Note: When returning to a byte read, remaining bits are dropped
872
- *
873
- * @param {boolean} unsigned - if the value is unsigned
874
- * @returns number
875
- */
876
- bit7be(unsigned?: boolean): number;
877
- /**
878
- * Bit field reader
879
- *
880
- * Note: When returning to a byte read, remaining bits are dropped
881
- *
882
- * @returns number
883
- */
884
- ubit7(): number;
885
- /**
886
- * Bit field reader
887
- *
888
- * Note: When returning to a byte read, remaining bits are dropped
889
- *
890
- * @returns number
891
- */
892
- ubit7le(): number;
893
- /**
894
- * Bit field reader
895
- *
896
- * Note: When returning to a byte read, remaining bits are dropped
897
- *
898
- * @returns number
899
- */
900
- ubit7be(): number;
901
- /**
902
- * Bit field reader
903
- *
904
- * Note: When returning to a byte read, remaining bits are dropped
905
- *
906
- * @param {boolean} unsigned - if the value is unsigned
907
- * @returns number
908
- */
909
- bit8(unsigned?: boolean): number;
910
- /**
911
- * Bit field reader
912
- *
913
- * Note: When returning to a byte read, remaining bits are dropped
914
- *
915
- * @param {boolean} unsigned - if the value is unsigned
916
- * @returns number
917
- */
918
- bit8le(unsigned?: boolean): number;
919
- /**
920
- * Bit field reader
921
- *
922
- * Note: When returning to a byte read, remaining bits are dropped
923
- *
924
- * @param {boolean} unsigned - if the value is unsigned
925
- * @returns number
926
- */
927
- bit8be(unsigned?: boolean): number;
928
- /**
929
- * Bit field reader
930
- *
931
- * Note: When returning to a byte read, remaining bits are dropped
932
- *
933
- * @returns number
934
- */
935
- ubit8(): number;
936
- /**
937
- * Bit field reader
938
- *
939
- * Note: When returning to a byte read, remaining bits are dropped
940
- *
941
- * @returns number
942
- */
943
- ubit8le(): number;
944
- /**
945
- * Bit field reader
946
- *
947
- * Note: When returning to a byte read, remaining bits are dropped
948
- *
949
- * @returns number
950
- */
951
- ubit8be(): number;
952
- /**
953
- * Bit field reader
954
- *
955
- * Note: When returning to a byte read, remaining bits are dropped
956
- *
957
- * @param {boolean} unsigned - if the value is unsigned
958
- * @returns number
959
- */
960
- bit9(unsigned?: boolean): number;
961
- /**
962
- * Bit field reader
963
- *
964
- * Note: When returning to a byte read, remaining bits are dropped
965
- *
966
- * @param {boolean} unsigned - if the value is unsigned
967
- * @returns number
968
- */
969
- bit9le(unsigned?: boolean): number;
970
- /**
971
- * Bit field reader
972
- *
973
- * Note: When returning to a byte read, remaining bits are dropped
974
- *
975
- * @param {boolean} unsigned - if the value is unsigned
976
- * @returns number
977
- */
978
- bit9be(unsigned?: boolean): number;
979
- /**
980
- * Bit field reader
981
- *
982
- * Note: When returning to a byte read, remaining bits are dropped
983
- *
984
- * @returns number
985
- */
986
- ubit9(): number;
987
- /**
988
- * Bit field reader
989
- *
990
- * Note: When returning to a byte read, remaining bits are dropped
991
- *
992
- * @returns number
993
- */
994
- ubit9le(): number;
995
- /**
996
- * Bit field reader
997
- *
998
- * Note: When returning to a byte read, remaining bits are dropped
999
- *
1000
- * @returns number
1001
- */
1002
- ubit9be(): number;
1003
- /**
1004
- * Bit field reader
1005
- *
1006
- * Note: When returning to a byte read, remaining bits are dropped
1007
- *
1008
- * @param {boolean} unsigned - if the value is unsigned
1009
- * @returns number
1010
- */
1011
- bit10(unsigned?: boolean): number;
1012
- /**
1013
- * Bit field reader
1014
- *
1015
- * Note: When returning to a byte read, remaining bits are dropped
1016
- *
1017
- * @param {boolean} unsigned - if the value is unsigned
1018
- * @returns number
1019
- */
1020
- bit10le(unsigned?: boolean): number;
1021
- /**
1022
- * Bit field reader
1023
- *
1024
- * Note: When returning to a byte read, remaining bits are dropped
1025
- *
1026
- * @param {boolean} unsigned - if the value is unsigned
1027
- * @returns number
1028
- */
1029
- bit10be(unsigned?: boolean): number;
1030
- /**
1031
- * Bit field reader
1032
- *
1033
- * Note: When returning to a byte read, remaining bits are dropped
1034
- *
1035
- * @returns number
1036
- */
1037
- ubit10(): number;
1038
- /**
1039
- * Bit field reader
1040
- *
1041
- * Note: When returning to a byte read, remaining bits are dropped
1042
- *
1043
- * @returns number
1044
- */
1045
- ubit10le(): number;
1046
- /**
1047
- * Bit field reader
1048
- *
1049
- * Note: When returning to a byte read, remaining bits are dropped
1050
- *
1051
- * @returns number
1052
- */
1053
- ubit10be(): number;
1054
- /**
1055
- * Bit field reader
1056
- *
1057
- * Note: When returning to a byte read, remaining bits are dropped
1058
- *
1059
- * @param {boolean} unsigned - if the value is unsigned
1060
- * @returns number
1061
- */
1062
- bit11(unsigned?: boolean): number;
1063
- /**
1064
- * Bit field reader
1065
- *
1066
- * Note: When returning to a byte read, remaining bits are dropped
1067
- *
1068
- * @param {boolean} unsigned - if the value is unsigned
1069
- * @returns number
1070
- */
1071
- bit11le(unsigned?: boolean): number;
1072
- /**
1073
- * Bit field reader
1074
- *
1075
- * Note: When returning to a byte read, remaining bits are dropped
1076
- *
1077
- * @param {boolean} unsigned - if the value is unsigned
1078
- * @returns number
1079
- */
1080
- bit11be(unsigned?: boolean): number;
1081
- /**
1082
- * Bit field reader
1083
- *
1084
- * Note: When returning to a byte read, remaining bits are dropped
1085
- *
1086
- * @returns number
1087
- */
1088
- ubit11(): number;
1089
- /**
1090
- * Bit field reader
1091
- *
1092
- * Note: When returning to a byte read, remaining bits are dropped
1093
- *
1094
- * @returns number
1095
- */
1096
- ubit11le(): number;
1097
- /**
1098
- * Bit field reader
1099
- *
1100
- * Note: When returning to a byte read, remaining bits are dropped
1101
- *
1102
- * @returns number
1103
- */
1104
- ubit11be(): number;
1105
- /**
1106
- * Bit field reader
1107
- *
1108
- * Note: When returning to a byte read, remaining bits are dropped
1109
- *
1110
- * @param {boolean} unsigned - if the value is unsigned
1111
- * @returns number
1112
- */
1113
- bit12(unsigned?: boolean): number;
1114
- /**
1115
- * Bit field reader
1116
- *
1117
- * Note: When returning to a byte read, remaining bits are dropped
1118
- *
1119
- * @param {boolean} unsigned - if the value is unsigned
1120
- * @returns number
1121
- */
1122
- bit12le(unsigned?: boolean): number;
1123
- /**
1124
- * Bit field reader
1125
- *
1126
- * Note: When returning to a byte read, remaining bits are dropped
1127
- *
1128
- * @param {boolean} unsigned - if the value is unsigned
1129
- * @returns number
1130
- */
1131
- bit12be(unsigned?: boolean): number;
1132
- /**
1133
- * Bit field reader
1134
- *
1135
- * Note: When returning to a byte read, remaining bits are dropped
1136
- *
1137
- * @returns number
1138
- */
1139
- ubit12(): number;
1140
- /**
1141
- * Bit field reader
1142
- *
1143
- * Note: When returning to a byte read, remaining bits are dropped
1144
- *
1145
- * @returns number
1146
- */
1147
- ubit12le(): number;
1148
- /**
1149
- * Bit field reader
1150
- *
1151
- * Note: When returning to a byte read, remaining bits are dropped
1152
- *
1153
- * @returns number
1154
- */
1155
- ubit12be(): number;
1156
- /**
1157
- * Bit field reader
1158
- *
1159
- * Note: When returning to a byte read, remaining bits are dropped
1160
- *
1161
- * @param {boolean} unsigned - if the value is unsigned
1162
- * @returns number
1163
- */
1164
- bit13(unsigned?: boolean): number;
1165
- /**
1166
- * Bit field reader
1167
- *
1168
- * Note: When returning to a byte read, remaining bits are dropped
1169
- *
1170
- * @param {boolean} unsigned - if the value is unsigned
1171
- * @returns number
1172
- */
1173
- bit13le(unsigned?: boolean): number;
1174
- /**
1175
- * Bit field reader
1176
- *
1177
- * Note: When returning to a byte read, remaining bits are dropped
1178
- *
1179
- * @param {boolean} unsigned - if the value is unsigned
1180
- * @returns number
1181
- */
1182
- bit13be(unsigned?: boolean): number;
1183
- /**
1184
- * Bit field reader
1185
- *
1186
- * Note: When returning to a byte read, remaining bits are dropped
1187
- *
1188
- * @returns number
1189
- */
1190
- ubit13(): number;
1191
- /**
1192
- * Bit field reader
1193
- *
1194
- * Note: When returning to a byte read, remaining bits are dropped
1195
- *
1196
- * @returns number
1197
- */
1198
- ubit13le(): number;
1199
- /**
1200
- * Bit field reader
1201
- *
1202
- * Note: When returning to a byte read, remaining bits are dropped
1203
- *
1204
- * @returns number
1205
- */
1206
- ubit13be(): number;
1207
- /**
1208
- * Bit field reader
1209
- *
1210
- * Note: When returning to a byte read, remaining bits are dropped
1211
- *
1212
- * @param {boolean} unsigned - if the value is unsigned
1213
- * @returns number
1214
- */
1215
- bit14(unsigned?: boolean): number;
1216
- /**
1217
- * Bit field reader
1218
- *
1219
- * Note: When returning to a byte read, remaining bits are dropped
1220
- *
1221
- * @param {boolean} unsigned - if the value is unsigned
1222
- * @returns number
1223
- */
1224
- bit14le(unsigned?: boolean): number;
1225
- /**
1226
- * Bit field reader
1227
- *
1228
- * Note: When returning to a byte read, remaining bits are dropped
1229
- *
1230
- * @param {boolean} unsigned - if the value is unsigned
1231
- * @returns number
1232
- */
1233
- bit14be(unsigned?: boolean): number;
1234
- /**
1235
- * Bit field reader
1236
- *
1237
- * Note: When returning to a byte read, remaining bits are dropped
1238
- *
1239
- * @returns number
1240
- */
1241
- ubit14(): number;
1242
- /**
1243
- * Bit field reader
1244
- *
1245
- * Note: When returning to a byte read, remaining bits are dropped
1246
- *
1247
- * @returns number
1248
- */
1249
- ubit14le(): number;
1250
- /**
1251
- * Bit field reader
1252
- *
1253
- * Note: When returning to a byte read, remaining bits are dropped
1254
- *
1255
- * @returns number
1256
- */
1257
- ubit14be(): number;
1258
- /**
1259
- * Bit field reader
1260
- *
1261
- * Note: When returning to a byte read, remaining bits are dropped
1262
- *
1263
- * @param {boolean} unsigned - if the value is unsigned
1264
- * @returns number
1265
- */
1266
- bit15(unsigned?: boolean): number;
1267
- /**
1268
- * Bit field reader
1269
- *
1270
- * Note: When returning to a byte read, remaining bits are dropped
1271
- *
1272
- * @param {boolean} unsigned - if the value is unsigned
1273
- * @returns number
1274
- */
1275
- bit15le(unsigned?: boolean): number;
1276
- /**
1277
- * Bit field reader
1278
- *
1279
- * Note: When returning to a byte read, remaining bits are dropped
1280
- *
1281
- * @param {boolean} unsigned - if the value is unsigned
1282
- * @returns number
1283
- */
1284
- bit15be(unsigned?: boolean): number;
1285
- /**
1286
- * Bit field reader
1287
- *
1288
- * Note: When returning to a byte read, remaining bits are dropped
1289
- *
1290
- * @returns number
1291
- */
1292
- ubit15(): number;
1293
- /**
1294
- * Bit field reader
1295
- *
1296
- * Note: When returning to a byte read, remaining bits are dropped
1297
- *
1298
- * @returns number
1299
- */
1300
- ubit15le(): number;
1301
- /**
1302
- * Bit field reader
1303
- *
1304
- * Note: When returning to a byte read, remaining bits are dropped
1305
- *
1306
- * @returns number
1307
- */
1308
- ubit15be(): number;
1309
- /**
1310
- * Bit field reader
1311
- *
1312
- * Note: When returning to a byte read, remaining bits are dropped
1313
- *
1314
- * @param {boolean} unsigned - if the value is unsigned
1315
- * @returns number
1316
- */
1317
- bit16(unsigned?: boolean): number;
1318
- /**
1319
- * Bit field reader
1320
- *
1321
- * Note: When returning to a byte read, remaining bits are dropped
1322
- *
1323
- * @param {boolean} unsigned - if the value is unsigned
1324
- * @returns number
1325
- */
1326
- bit16le(unsigned?: boolean): number;
1327
- /**
1328
- * Bit field reader
1329
- *
1330
- * Note: When returning to a byte read, remaining bits are dropped
1331
- *
1332
- * @param {boolean} unsigned - if the value is unsigned
1333
- * @returns number
1334
- */
1335
- bit16be(unsigned?: boolean): number;
1336
- /**
1337
- * Bit field reader
1338
- *
1339
- * Note: When returning to a byte read, remaining bits are dropped
1340
- *
1341
- * @returns number
1342
- */
1343
- ubit16(): number;
1344
- /**
1345
- * Bit field reader
1346
- *
1347
- * Note: When returning to a byte read, remaining bits are dropped
1348
- *
1349
- * @returns number
1350
- */
1351
- ubit16le(): number;
1352
- /**
1353
- * Bit field reader
1354
- *
1355
- * Note: When returning to a byte read, remaining bits are dropped
1356
- *
1357
- * @returns number
1358
- */
1359
- ubit16be(): number;
1360
- /**
1361
- * Bit field reader
1362
- *
1363
- * Note: When returning to a byte read, remaining bits are dropped
1364
- *
1365
- * @param {boolean} unsigned - if the value is unsigned
1366
- * @returns number
1367
- */
1368
- bit17(unsigned?: boolean): number;
1369
- /**
1370
- * Bit field reader
1371
- *
1372
- * Note: When returning to a byte read, remaining bits are dropped
1373
- *
1374
- * @param {boolean} unsigned - if the value is unsigned
1375
- * @returns number
1376
- */
1377
- bit17le(unsigned?: boolean): number;
1378
- /**
1379
- * Bit field reader
1380
- *
1381
- * Note: When returning to a byte read, remaining bits are dropped
1382
- *
1383
- * @param {boolean} unsigned - if the value is unsigned
1384
- * @returns number
1385
- */
1386
- bit17be(unsigned?: boolean): number;
1387
- /**
1388
- * Bit field reader
1389
- *
1390
- * Note: When returning to a byte read, remaining bits are dropped
1391
- *
1392
- * @returns number
1393
- */
1394
- ubit17(): number;
1395
- /**
1396
- * Bit field reader
1397
- *
1398
- * Note: When returning to a byte read, remaining bits are dropped
1399
- *
1400
- * @returns number
1401
- */
1402
- ubit17le(): number;
1403
- /**
1404
- * Bit field reader
1405
- *
1406
- * Note: When returning to a byte read, remaining bits are dropped
1407
- *
1408
- * @returns number
1409
- */
1410
- ubit17be(): number;
1411
- /**
1412
- * Bit field reader
1413
- *
1414
- * Note: When returning to a byte read, remaining bits are dropped
1415
- *
1416
- * @param {boolean} unsigned - if the value is unsigned
1417
- * @returns number
1418
- */
1419
- bit18(unsigned?: boolean): number;
1420
- /**
1421
- * Bit field reader
1422
- *
1423
- * Note: When returning to a byte read, remaining bits are dropped
1424
- *
1425
- * @param {boolean} unsigned - if the value is unsigned
1426
- * @returns number
1427
- */
1428
- bit18le(unsigned?: boolean): number;
1429
- /**
1430
- * Bit field reader
1431
- *
1432
- * Note: When returning to a byte read, remaining bits are dropped
1433
- *
1434
- * @param {boolean} unsigned - if the value is unsigned
1435
- * @returns number
1436
- */
1437
- bit18be(unsigned?: boolean): number;
1438
- /**
1439
- * Bit field reader
1440
- *
1441
- * Note: When returning to a byte read, remaining bits are dropped
1442
- *
1443
- * @returns number
1444
- */
1445
- ubit18(): number;
1446
- /**
1447
- * Bit field reader
1448
- *
1449
- * Note: When returning to a byte read, remaining bits are dropped
1450
- *
1451
- * @returns number
1452
- */
1453
- ubit18le(): number;
1454
- /**
1455
- * Bit field reader
1456
- *
1457
- * Note: When returning to a byte read, remaining bits are dropped
1458
- *
1459
- * @returns number
1460
- */
1461
- ubit18be(): number;
1462
- /**
1463
- * Bit field reader
1464
- *
1465
- * Note: When returning to a byte read, remaining bits are dropped
1466
- *
1467
- * @param {boolean} unsigned - if the value is unsigned
1468
- * @returns number
1469
- */
1470
- bit19(unsigned?: boolean): number;
1471
- /**
1472
- * Bit field reader
1473
- *
1474
- * Note: When returning to a byte read, remaining bits are dropped
1475
- *
1476
- * @param {boolean} unsigned - if the value is unsigned
1477
- * @returns number
1478
- */
1479
- bit19le(unsigned?: boolean): number;
1480
- /**
1481
- * Bit field reader
1482
- *
1483
- * Note: When returning to a byte read, remaining bits are dropped
1484
- *
1485
- * @param {boolean} unsigned - if the value is unsigned
1486
- * @returns number
1487
- */
1488
- bit19be(unsigned?: boolean): number;
1489
- /**
1490
- * Bit field reader
1491
- *
1492
- * Note: When returning to a byte read, remaining bits are dropped
1493
- *
1494
- * @returns number
1495
- */
1496
- ubit19(): number;
1497
- /**
1498
- * Bit field reader
1499
- *
1500
- * Note: When returning to a byte read, remaining bits are dropped
1501
- *
1502
- * @returns number
1503
- */
1504
- ubit19le(): number;
1505
- /**
1506
- * Bit field reader
1507
- *
1508
- * Note: When returning to a byte read, remaining bits are dropped
1509
- *
1510
- * @returns number
1511
- */
1512
- ubit19be(): number;
1513
- /**
1514
- * Bit field reader
1515
- *
1516
- * Note: When returning to a byte read, remaining bits are dropped
1517
- *
1518
- * @param {boolean} unsigned - if the value is unsigned
1519
- * @returns number
1520
- */
1521
- bit20(unsigned?: boolean): number;
1522
- /**
1523
- * Bit field reader
1524
- *
1525
- * Note: When returning to a byte read, remaining bits are dropped
1526
- *
1527
- * @param {boolean} unsigned - if the value is unsigned
1528
- * @returns number
1529
- */
1530
- bit20le(unsigned?: boolean): number;
1531
- /**
1532
- * Bit field reader
1533
- *
1534
- * Note: When returning to a byte read, remaining bits are dropped
1535
- *
1536
- * @param {boolean} unsigned - if the value is unsigned
1537
- * @returns number
1538
- */
1539
- bit20be(unsigned?: boolean): number;
1540
- /**
1541
- * Bit field reader
1542
- *
1543
- * Note: When returning to a byte read, remaining bits are dropped
1544
- *
1545
- * @returns number
1546
- */
1547
- ubit20(): number;
1548
- /**
1549
- * Bit field reader
1550
- *
1551
- * Note: When returning to a byte read, remaining bits are dropped
1552
- *
1553
- * @returns number
1554
- */
1555
- ubit20le(): number;
1556
- /**
1557
- * Bit field reader
1558
- *
1559
- * Note: When returning to a byte read, remaining bits are dropped
1560
- *
1561
- * @returns number
1562
- */
1563
- ubit20be(): number;
1564
- /**
1565
- * Bit field reader
1566
- *
1567
- * Note: When returning to a byte read, remaining bits are dropped
1568
- *
1569
- * @param {boolean} unsigned - if the value is unsigned
1570
- * @returns number
1571
- */
1572
- bit21(unsigned?: boolean): number;
1573
- /**
1574
- * Bit field reader
1575
- *
1576
- * Note: When returning to a byte read, remaining bits are dropped
1577
- *
1578
- * @param {boolean} unsigned - if the value is unsigned
1579
- * @returns number
1580
- */
1581
- bit21le(unsigned?: boolean): number;
1582
- /**
1583
- * Bit field reader
1584
- *
1585
- * Note: When returning to a byte read, remaining bits are dropped
1586
- *
1587
- * @param {boolean} unsigned - if the value is unsigned
1588
- * @returns number
1589
- */
1590
- bit21be(unsigned?: boolean): number;
1591
- /**
1592
- * Bit field reader
1593
- *
1594
- * Note: When returning to a byte read, remaining bits are dropped
1595
- *
1596
- * @returns number
1597
- */
1598
- ubit21(): number;
1599
- /**
1600
- * Bit field reader
1601
- *
1602
- * Note: When returning to a byte read, remaining bits are dropped
1603
- *
1604
- * @returns number
1605
- */
1606
- ubit21le(): number;
1607
- /**
1608
- * Bit field reader
1609
- *
1610
- * Note: When returning to a byte read, remaining bits are dropped
1611
- *
1612
- * @returns number
1613
- */
1614
- ubit21be(): number;
1615
- /**
1616
- * Bit field reader
1617
- *
1618
- * Note: When returning to a byte read, remaining bits are dropped
1619
- *
1620
- * @param {boolean} unsigned - if the value is unsigned
1621
- * @returns number
1622
- */
1623
- bit22(unsigned?: boolean): number;
1624
- /**
1625
- * Bit field reader
1626
- *
1627
- * Note: When returning to a byte read, remaining bits are dropped
1628
- *
1629
- * @param {boolean} unsigned - if the value is unsigned
1630
- * @returns number
1631
- */
1632
- bit22le(unsigned?: boolean): number;
1633
- /**
1634
- * Bit field reader
1635
- *
1636
- * Note: When returning to a byte read, remaining bits are dropped
1637
- *
1638
- * @param {boolean} unsigned - if the value is unsigned
1639
- * @returns number
1640
- */
1641
- bit22be(unsigned?: boolean): number;
1642
- /**
1643
- * Bit field reader
1644
- *
1645
- * Note: When returning to a byte read, remaining bits are dropped
1646
- *
1647
- * @returns number
1648
- */
1649
- ubit22(): number;
1650
- /**
1651
- * Bit field reader
1652
- *
1653
- * Note: When returning to a byte read, remaining bits are dropped
1654
- *
1655
- * @returns number
1656
- */
1657
- ubit22le(): number;
1658
- /**
1659
- * Bit field reader
1660
- *
1661
- * Note: When returning to a byte read, remaining bits are dropped
1662
- *
1663
- * @returns number
1664
- */
1665
- ubit22be(): number;
1666
- /**
1667
- * Bit field reader
1668
- *
1669
- * Note: When returning to a byte read, remaining bits are dropped
1670
- *
1671
- * @param {boolean} unsigned - if the value is unsigned
1672
- * @returns number
1673
- */
1674
- bit23(unsigned?: boolean): number;
1675
- /**
1676
- * Bit field reader
1677
- *
1678
- * Note: When returning to a byte read, remaining bits are dropped
1679
- *
1680
- * @param {boolean} unsigned - if the value is unsigned
1681
- * @returns number
1682
- */
1683
- bit23le(unsigned?: boolean): number;
1684
- /**
1685
- * Bit field reader
1686
- *
1687
- * Note: When returning to a byte read, remaining bits are dropped
1688
- *
1689
- * @param {boolean} unsigned - if the value is unsigned
1690
- * @returns number
1691
- */
1692
- bit23be(unsigned?: boolean): number;
1693
- /**
1694
- * Bit field reader
1695
- *
1696
- * Note: When returning to a byte read, remaining bits are dropped
1697
- *
1698
- * @returns number
1699
- */
1700
- ubit23(): number;
1701
- /**
1702
- * Bit field reader
1703
- *
1704
- * Note: When returning to a byte read, remaining bits are dropped
1705
- *
1706
- * @returns number
1707
- */
1708
- ubit23le(): number;
1709
- /**
1710
- * Bit field reader
1711
- *
1712
- * Note: When returning to a byte read, remaining bits are dropped
1713
- *
1714
- * @returns number
1715
- */
1716
- ubit23be(): number;
1717
- /**
1718
- * Bit field reader
1719
- *
1720
- * Note: When returning to a byte read, remaining bits are dropped
1721
- *
1722
- * @param {boolean} unsigned - if the value is unsigned
1723
- * @returns number
1724
- */
1725
- bit24(unsigned?: boolean): number;
1726
- /**
1727
- * Bit field reader
1728
- *
1729
- * Note: When returning to a byte read, remaining bits are dropped
1730
- *
1731
- * @param {boolean} unsigned - if the value is unsigned
1732
- * @returns number
1733
- */
1734
- bit24le(unsigned?: boolean): number;
1735
- /**
1736
- * Bit field reader
1737
- *
1738
- * Note: When returning to a byte read, remaining bits are dropped
1739
- *
1740
- * @param {boolean} unsigned - if the value is unsigned
1741
- * @returns number
1742
- */
1743
- bit24be(unsigned?: boolean): number;
1744
- /**
1745
- * Bit field reader
1746
- *
1747
- * Note: When returning to a byte read, remaining bits are dropped
1748
- *
1749
- * @returns number
1750
- */
1751
- ubit24(): number;
1752
- /**
1753
- * Bit field reader
1754
- *
1755
- * Note: When returning to a byte read, remaining bits are dropped
1756
- *
1757
- * @returns number
1758
- */
1759
- ubit24le(): number;
1760
- /**
1761
- * Bit field reader
1762
- *
1763
- * Note: When returning to a byte read, remaining bits are dropped
1764
- *
1765
- * @returns number
1766
- */
1767
- ubit24be(): number;
1768
- /**
1769
- * Bit field reader
1770
- *
1771
- * Note: When returning to a byte read, remaining bits are dropped
1772
- *
1773
- * @param {boolean} unsigned - if the value is unsigned
1774
- * @returns number
1775
- */
1776
- bit25(unsigned?: boolean): number;
1777
- /**
1778
- * Bit field reader
1779
- *
1780
- * Note: When returning to a byte read, remaining bits are dropped
1781
- *
1782
- * @param {boolean} unsigned - if the value is unsigned
1783
- * @returns number
1784
- */
1785
- bit25le(unsigned?: boolean): number;
1786
- /**
1787
- * Bit field reader
1788
- *
1789
- * Note: When returning to a byte read, remaining bits are dropped
1790
- *
1791
- * @param {boolean} unsigned - if the value is unsigned
1792
- * @returns number
1793
- */
1794
- bit25be(unsigned?: boolean): number;
1795
- /**
1796
- * Bit field reader
1797
- *
1798
- * Note: When returning to a byte read, remaining bits are dropped
1799
- *
1800
- * @returns number
1801
- */
1802
- ubit25(): number;
1803
- /**
1804
- * Bit field reader
1805
- *
1806
- * Note: When returning to a byte read, remaining bits are dropped
1807
- *
1808
- * @returns number
1809
- */
1810
- ubit25le(): number;
1811
- /**
1812
- * Bit field reader
1813
- *
1814
- * Note: When returning to a byte read, remaining bits are dropped
1815
- *
1816
- * @returns number
1817
- */
1818
- ubit25be(): number;
1819
- /**
1820
- * Bit field reader
1821
- *
1822
- * Note: When returning to a byte read, remaining bits are dropped
1823
- *
1824
- * @param {boolean} unsigned - if the value is unsigned
1825
- * @returns number
1826
- */
1827
- bit26(unsigned?: boolean): number;
1828
- /**
1829
- * Bit field reader
1830
- *
1831
- * Note: When returning to a byte read, remaining bits are dropped
1832
- *
1833
- * @param {boolean} unsigned - if the value is unsigned
1834
- * @returns number
1835
- */
1836
- bit26le(unsigned?: boolean): number;
1837
- /**
1838
- * Bit field reader
1839
- *
1840
- * Note: When returning to a byte read, remaining bits are dropped
1841
- *
1842
- * @param {boolean} unsigned - if the value is unsigned
1843
- * @returns number
1844
- */
1845
- bit26be(unsigned?: boolean): number;
1846
- /**
1847
- * Bit field reader
1848
- *
1849
- * Note: When returning to a byte read, remaining bits are dropped
1850
- *
1851
- * @returns number
1852
- */
1853
- ubit26(): number;
1854
- /**
1855
- * Bit field reader
1856
- *
1857
- * Note: When returning to a byte read, remaining bits are dropped
1858
- *
1859
- * @returns number
1860
- */
1861
- ubit26le(): number;
1862
- /**
1863
- * Bit field reader
1864
- *
1865
- * Note: When returning to a byte read, remaining bits are dropped
1866
- *
1867
- * @returns number
1868
- */
1869
- ubit26be(): number;
1870
- /**
1871
- * Bit field reader
1872
- *
1873
- * Note: When returning to a byte read, remaining bits are dropped
1874
- *
1875
- * @param {boolean} unsigned - if the value is unsigned
1876
- * @returns number
1877
- */
1878
- bit27(unsigned?: boolean): number;
1879
- /**
1880
- * Bit field reader
1881
- *
1882
- * Note: When returning to a byte read, remaining bits are dropped
1883
- *
1884
- * @param {boolean} unsigned - if the value is unsigned
1885
- * @returns number
1886
- */
1887
- bit27le(unsigned?: boolean): number;
1888
- /**
1889
- * Bit field reader
1890
- *
1891
- * Note: When returning to a byte read, remaining bits are dropped
1892
- *
1893
- * @param {boolean} unsigned - if the value is unsigned
1894
- * @returns number
1895
- */
1896
- bit27be(unsigned?: boolean): number;
1897
- /**
1898
- * Bit field reader
1899
- *
1900
- * Note: When returning to a byte read, remaining bits are dropped
1901
- *
1902
- * @returns number
1903
- */
1904
- ubit27(): number;
1905
- /**
1906
- * Bit field reader
1907
- *
1908
- * Note: When returning to a byte read, remaining bits are dropped
1909
- *
1910
- * @returns number
1911
- */
1912
- ubit27le(): number;
1913
- /**
1914
- * Bit field reader
1915
- *
1916
- * Note: When returning to a byte read, remaining bits are dropped
1917
- *
1918
- * @returns number
1919
- */
1920
- ubit27be(): number;
1921
- /**
1922
- * Bit field reader
1923
- *
1924
- * Note: When returning to a byte read, remaining bits are dropped
1925
- *
1926
- * @param {boolean} unsigned - if the value is unsigned
1927
- * @returns number
1928
- */
1929
- bit28(unsigned?: boolean): number;
1930
- /**
1931
- * Bit field reader
1932
- *
1933
- * Note: When returning to a byte read, remaining bits are dropped
1934
- *
1935
- * @param {boolean} unsigned - if the value is unsigned
1936
- * @returns number
1937
- */
1938
- bit28le(unsigned?: boolean): number;
1939
- /**
1940
- * Bit field reader
1941
- *
1942
- * Note: When returning to a byte read, remaining bits are dropped
1943
- *
1944
- * @param {boolean} unsigned - if the value is unsigned
1945
- * @returns number
1946
- */
1947
- bit28be(unsigned?: boolean): number;
1948
- /**
1949
- * Bit field reader
1950
- *
1951
- * Note: When returning to a byte read, remaining bits are dropped
1952
- *
1953
- * @returns number
1954
- */
1955
- ubit28(): number;
1956
- /**
1957
- * Bit field reader
1958
- *
1959
- * Note: When returning to a byte read, remaining bits are dropped
1960
- *
1961
- * @returns number
1962
- */
1963
- ubit28le(): number;
1964
- /**
1965
- * Bit field reader
1966
- *
1967
- * Note: When returning to a byte read, remaining bits are dropped
1968
- *
1969
- * @returns number
1970
- */
1971
- ubit28be(): number;
1972
- /**
1973
- * Bit field reader
1974
- *
1975
- * Note: When returning to a byte read, remaining bits are dropped
1976
- *
1977
- * @param {boolean} unsigned - if the value is unsigned
1978
- * @returns number
1979
- */
1980
- bit29(unsigned?: boolean): number;
1981
- /**
1982
- * Bit field reader
1983
- *
1984
- * Note: When returning to a byte read, remaining bits are dropped
1985
- *
1986
- * @param {boolean} unsigned - if the value is unsigned
1987
- * @returns number
1988
- */
1989
- bit29le(unsigned?: boolean): number;
1990
- /**
1991
- * Bit field reader
1992
- *
1993
- * Note: When returning to a byte read, remaining bits are dropped
1994
- *
1995
- * @param {boolean} unsigned - if the value is unsigned
1996
- * @returns number
1997
- */
1998
- bit29be(unsigned?: boolean): number;
1999
- /**
2000
- * Bit field reader
2001
- *
2002
- * Note: When returning to a byte read, remaining bits are dropped
2003
- *
2004
- * @returns number
2005
- */
2006
- ubit29(): number;
2007
- /**
2008
- * Bit field reader
2009
- *
2010
- * Note: When returning to a byte read, remaining bits are dropped
2011
- *
2012
- * @returns number
2013
- */
2014
- ubit29le(): number;
2015
- /**
2016
- * Bit field reader
2017
- *
2018
- * Note: When returning to a byte read, remaining bits are dropped
2019
- *
2020
- * @returns number
2021
- */
2022
- ubit29be(): number;
2023
- /**
2024
- * Bit field reader
2025
- *
2026
- * Note: When returning to a byte read, remaining bits are dropped
2027
- *
2028
- * @param {boolean} unsigned - if the value is unsigned
2029
- * @returns number
2030
- */
2031
- bit30(unsigned?: boolean): number;
2032
- /**
2033
- * Bit field reader
2034
- *
2035
- * Note: When returning to a byte read, remaining bits are dropped
2036
- *
2037
- * @param {boolean} unsigned - if the value is unsigned
2038
- * @returns number
2039
- */
2040
- bit30le(unsigned?: boolean): number;
2041
- /**
2042
- * Bit field reader
2043
- *
2044
- * Note: When returning to a byte read, remaining bits are dropped
2045
- *
2046
- * @param {boolean} unsigned - if the value is unsigned
2047
- * @returns number
2048
- */
2049
- bit30be(unsigned?: boolean): number;
2050
- /**
2051
- * Bit field reader
2052
- *
2053
- * Note: When returning to a byte read, remaining bits are dropped
2054
- *
2055
- * @returns number
2056
- */
2057
- ubit30(): number;
2058
- /**
2059
- * Bit field reader
2060
- *
2061
- * Note: When returning to a byte read, remaining bits are dropped
2062
- *
2063
- * @returns number
2064
- */
2065
- ubit30le(): number;
2066
- /**
2067
- * Bit field reader
2068
- *
2069
- * Note: When returning to a byte read, remaining bits are dropped
2070
- *
2071
- * @returns number
2072
- */
2073
- ubit30be(): number;
2074
- /**
2075
- * Bit field reader
2076
- *
2077
- * Note: When returning to a byte read, remaining bits are dropped
2078
- *
2079
- * @param {boolean} unsigned - if the value is unsigned
2080
- * @returns number
2081
- */
2082
- bit31(unsigned?: boolean): number;
2083
- /**
2084
- * Bit field reader
2085
- *
2086
- * Note: When returning to a byte read, remaining bits are dropped
2087
- *
2088
- * @param {boolean} unsigned - if the value is unsigned
2089
- * @returns number
2090
- */
2091
- bit31le(unsigned?: boolean): number;
2092
- /**
2093
- * Bit field reader
2094
- *
2095
- * Note: When returning to a byte read, remaining bits are dropped
2096
- *
2097
- * @param {boolean} unsigned - if the value is unsigned
2098
- * @returns number
2099
- */
2100
- bit31be(unsigned?: boolean): number;
2101
- /**
2102
- * Bit field reader
2103
- *
2104
- * Note: When returning to a byte read, remaining bits are dropped
2105
- *
2106
- * @returns number
2107
- */
2108
- ubit31(): number;
2109
- /**
2110
- * Bit field reader
2111
- *
2112
- * Note: When returning to a byte read, remaining bits are dropped
2113
- *
2114
- * @returns number
2115
- */
2116
- ubit31le(): number;
2117
- /**
2118
- * Bit field reader
2119
- *
2120
- * Note: When returning to a byte read, remaining bits are dropped
2121
- *
2122
- * @returns number
2123
- */
2124
- ubit31be(): number;
2125
- /**
2126
- * Bit field reader
2127
- *
2128
- * Note: When returning to a byte read, remaining bits are dropped
2129
- *
2130
- * @param {boolean} unsigned - if the value is unsigned
2131
- * @returns number
2132
- */
2133
- bit32(unsigned?: boolean): number;
2134
- /**
2135
- * Bit field reader
2136
- *
2137
- * Note: When returning to a byte read, remaining bits are dropped
2138
- *
2139
- * @param {boolean} unsigned - if the value is unsigned
2140
- * @returns number
2141
- */
2142
- bit32le(unsigned?: boolean): number;
2143
- /**
2144
- * Bit field reader
2145
- *
2146
- * Note: When returning to a byte read, remaining bits are dropped
2147
- *
2148
- * @param {boolean} unsigned - if the value is unsigned
2149
- * @returns number
2150
- */
2151
- bit32be(unsigned?: boolean): number;
2152
- /**
2153
- * Bit field reader
2154
- *
2155
- * Note: When returning to a byte read, remaining bits are dropped
2156
- *
2157
- * @returns number
2158
- */
2159
- ubit32(): number;
2160
- /**
2161
- * Bit field reader
2162
- *
2163
- * Note: When returning to a byte read, remaining bits are dropped
2164
- *
2165
- * @returns number
2166
- */
2167
- ubit32le(): number;
2168
- /**
2169
- * Bit field reader
2170
- *
2171
- * Note: When returning to a byte read, remaining bits are dropped
2172
- *
2173
- * @returns number
2174
- */
2175
- ubit32be(): number;
2176
- /**
2177
- * Bit field reader
2178
- *
2179
- * Note: When returning to a byte read, remaining bits are dropped
2180
- *
2181
- * @param {number} bits - bits to read
2182
- * @returns number
2183
- */
2184
- readUBitBE(bits: number): number;
2185
- /**
2186
- * Bit field reader
2187
- *
2188
- * Note: When returning to a byte read, remaining bits are dropped
2189
- *
2190
- * @param {number} bits - bits to read
2191
- * @returns number
2192
- */
2193
- ubitbe(bits: number): number;
2194
- /**
2195
- * Bit field reader
2196
- *
2197
- * Note: When returning to a byte read, remaining bits are dropped
2198
- *
2199
- * @param {number} bits - bits to read
2200
- * @param {boolean} unsigned - if the value is unsigned
2201
- * @returns number
2202
- */
2203
- readBitBE(bits: number, unsigned?: boolean): number;
2204
- /**
2205
- * Bit field reader
2206
- *
2207
- * Note: When returning to a byte read, remaining bits are dropped
2208
- *
2209
- * @param {number} bits - bits to read
2210
- * @param {boolean} unsigned - if the value is unsigned
2211
- * @returns number
2212
- */
2213
- bitbe(bits: number, unsigned?: boolean): number;
2214
- /**
2215
- * Bit field reader
2216
- *
2217
- * Note: When returning to a byte read, remaining bits are dropped
2218
- *
2219
- * @param {number} bits - bits to read
2220
- * @returns number
2221
- */
2222
- readUBitLE(bits: number): number;
2223
- /**
2224
- * Bit field reader
2225
- *
2226
- * Note: When returning to a byte read, remaining bits are dropped
2227
- *
2228
- * @param {number} bits - bits to read
2229
- * @returns number
2230
- */
2231
- ubitle(bits: number): number;
2232
- /**
2233
- * Bit field reader
2234
- *
2235
- * Note: When returning to a byte read, remaining bits are dropped
2236
- *
2237
- * @param {number} bits - bits to read
2238
- * @param {boolean} unsigned - if the value is unsigned
2239
- * @returns number
2240
- */
2241
- readBitLE(bits: number, unsigned?: boolean): number;
2242
- /**
2243
- * Bit field reader
2244
- *
2245
- * Note: When returning to a byte read, remaining bits are dropped
2246
- *
2247
- * @param {number} bits - bits to read
2248
- * @param {boolean} unsigned - if the value is unsigned
2249
- * @returns number
2250
- */
2251
- bitle(bits: number, unsigned?: boolean): number;
2252
- /**
2253
- * Read byte
2254
- *
2255
- * @param {boolean} unsigned - if value is unsigned or not
2256
- * @returns number
2257
- */
2258
- readByte(unsigned?: boolean): number;
2259
- /**
2260
- * Write byte
2261
- *
2262
- * @param {number} value - value as int
2263
- * @param {boolean} unsigned - if the value is unsigned
2264
- */
2265
- writeByte(value: number, unsigned?: boolean): void;
2266
- /**
2267
- * Read byte
2268
- *
2269
- * @param {boolean} unsigned - if value is unsigned or not
2270
- * @returns number
2271
- */
2272
- byte(unsigned?: boolean): number;
2273
- /**
2274
- * Read byte
2275
- *
2276
- * @param {boolean} unsigned - if value is unsigned or not
2277
- * @returns number
2278
- */
2279
- int8(unsigned?: boolean): number;
2280
- /**
2281
- * Read unsigned byte
2282
- *
2283
- * @returns number
2284
- */
2285
- readUByte(): number;
2286
- /**
2287
- * Read unsigned byte
2288
- *
2289
- * @returns number
2290
- */
2291
- uint8(): number;
2292
- /**
2293
- * Read unsigned byte
2294
- *
2295
- * @returns number
2296
- */
2297
- ubyte(): number;
2298
- /**
2299
- * Read short
2300
- *
2301
- * @param {boolean} unsigned - if value is unsigned or not
2302
- * @param {string} endian - ```big``` or ```little```
2303
- * @returns number
2304
- */
2305
- readInt16(unsigned?: boolean, endian?: string): number;
2306
- /**
2307
- * Write int16
2308
- *
2309
- * @param {number} value - value as int
2310
- * @param {boolean} unsigned - if the value is unsigned
2311
- * @param {string} endian - ``big`` or ``little`
2312
- */
2313
- writeInt16(value: number, unsigned?: boolean, endian?: string): void;
2314
- /**
2315
- * Read short
2316
- *
2317
- * @param {boolean} unsigned - if value is unsigned or not
2318
- * @param {string} endian - ```big``` or ```little```
2319
- * @returns number
2320
- */
2321
- int16(unsigned?: boolean, endian?: string): number;
2322
- /**
2323
- * Read short
2324
- *
2325
- * @param {boolean} unsigned - if value is unsigned or not
2326
- * @param {string} endian - ```big``` or ```little```
2327
- * @returns number
2328
- */
2329
- short(unsigned?: boolean, endian?: string): number;
2330
- /**
2331
- * Read short
2332
- *
2333
- * @param {boolean} unsigned - if value is unsigned or not
2334
- * @param {string} endian - ```big``` or ```little```
2335
- * @returns number
2336
- */
2337
- word(unsigned?: boolean, endian?: string): number;
2338
- /**
2339
- * Read unsigned short
2340
- *
2341
- * @param {string} endian - ```big``` or ```little```
2342
- *
2343
- * @returns number
2344
- */
2345
- readUInt16(endian?: string): number;
2346
- /**
2347
- * Read unsigned short
2348
- *
2349
- * @param {string} endian - ```big``` or ```little```
2350
- *
2351
- * @returns number
2352
- */
2353
- uint16(endian?: string): number;
2354
- /**
2355
- * Read unsigned short
2356
- *
2357
- * @param {string} endian - ```big``` or ```little```
2358
- *
2359
- * @returns number
2360
- */
2361
- ushort(endian?: string): number;
2362
- /**
2363
- * Read unsigned short
2364
- *
2365
- * @param {string} endian - ```big``` or ```little```
2366
- *
2367
- * @returns number
2368
- */
2369
- uword(endian?: string): number;
2370
- /**
2371
- * Read unsigned short in little endian
2372
- *
2373
- * @returns number
2374
- */
2375
- readUInt16LE(): number;
2376
- /**
2377
- * Read unsigned short in little endian
2378
- *
2379
- * @returns number
2380
- */
2381
- uint16le(): number;
2382
- /**
2383
- * Read unsigned short in little endian
2384
- *
2385
- * @returns number
2386
- */
2387
- ushortle(): number;
2388
- /**
2389
- * Read unsigned short in little endian
2390
- *
2391
- * @returns number
2392
- */
2393
- uwordle(): number;
2394
- /**
2395
- * Read signed short in little endian
2396
- *
2397
- * @returns number
2398
- */
2399
- readInt16LE(): number;
2400
- /**
2401
- * Read signed short in little endian
2402
- *
2403
- * @returns number
2404
- */
2405
- int16le(): number;
2406
- /**
2407
- * Read signed short in little endian
2408
- *
2409
- * @returns number
2410
- */
2411
- shortle(): number;
2412
- /**
2413
- * Read signed short in little endian
2414
- *
2415
- * @returns number
2416
- */
2417
- wordle(): number;
2418
- /**
2419
- * Read unsigned short in big endian
2420
- *
2421
- * @returns number
2422
- */
2423
- readUInt16BE(): number;
2424
- /**
2425
- * Read unsigned short in big endian
2426
- *
2427
- * @returns number
2428
- */
2429
- uint16be(): number;
2430
- /**
2431
- * Read unsigned short in big endian
2432
- *
2433
- * @returns number
2434
- */
2435
- ushortbe(): number;
2436
- /**
2437
- * Read unsigned short in big endian
2438
- *
2439
- * @returns number
2440
- */
2441
- uwordbe(): number;
2442
- /**
2443
- * Read signed short in big endian
2444
- *
2445
- * @returns number
2446
- */
2447
- readInt16BE(): number;
2448
- /**
2449
- * Read signed short in big endian
2450
- *
2451
- * @returns number
2452
- */
2453
- int16be(): number;
2454
- /**
2455
- * Read signed short in big endian
2456
- *
2457
- * @returns number
2458
- */
2459
- shortbe(): number;
2460
- /**
2461
- * Read signed short in big endian
2462
- *
2463
- * @returns number
2464
- */
2465
- wordbe(): number;
2466
- /**
2467
- * Read half float
2468
- *
2469
- * @param {string} endian - ```big``` or ```little```
2470
- * @returns number
2471
- */
2472
- readHalfFloat(endian?: string): number;
2473
- /**
2474
- * Writes half float
2475
- *
2476
- * @param {number} value - value as int
2477
- * @param {string} endian - ``big`` or ``little`
2478
- */
2479
- writeHalfFloat(value: number, endian?: string): void;
2480
- /**
2481
- * Read half float
2482
- *
2483
- * @param {string} endian - ```big``` or ```little```
2484
- * @returns number
2485
- */
2486
- halffloat(endian?: string): number;
2487
- /**
2488
- * Read half float
2489
- *
2490
- * @param {string} endian - ```big``` or ```little```
2491
- * @returns number
2492
- */
2493
- half(endian?: string): number;
2494
- /**
2495
- * Read half float
2496
- *
2497
- * @returns number
2498
- */
2499
- readHalfFloatBE(): number;
2500
- /**
2501
- * Read half float
2502
- *
2503
- * @returns number
2504
- */
2505
- halffloatbe(): number;
2506
- /**
2507
- * Read half float
2508
- *
2509
- * @returns number
2510
- */
2511
- halfbe(): number;
2512
- /**
2513
- * Read half float
2514
- *
2515
- * @returns number
2516
- */
2517
- readHalfFloatLE(): number;
2518
- /**
2519
- * Read half float
2520
- *
2521
- * @returns number
2522
- */
2523
- halffloatle(): number;
2524
- /**
2525
- * Read half float
2526
- *
2527
- * @returns number
2528
- */
2529
- halfle(): number;
2530
- /**
2531
- * Read 32 bit integer
2532
- *
2533
- * @param {boolean} unsigned - if value is unsigned or not
2534
- * @param {string} endian - ```big``` or ```little```
2535
- * @returns number
2536
- */
2537
- readInt32(unsigned?: boolean, endian?: string): number;
2538
- /**
2539
- * Write int32
2540
- *
2541
- * @param {number} value - value as int
2542
- * @param {boolean} unsigned - if the value is unsigned
2543
- * @param {string} endian - ``big`` or ``little`
2544
- */
2545
- writeInt32(value: number, unsigned?: boolean, endian?: string): void;
2546
- /**
2547
- * Read 32 bit integer
2548
- *
2549
- * @param {boolean} unsigned - if value is unsigned or not
2550
- * @param {string} endian - ```big``` or ```little```
2551
- * @returns number
2552
- */
2553
- int(unsigned?: boolean, endian?: string): number;
2554
- /**
2555
- * Read 32 bit integer
2556
- *
2557
- * @param {boolean} unsigned - if value is unsigned or not
2558
- * @param {string} endian - ```big``` or ```little```
2559
- * @returns number
2560
- */
2561
- double(unsigned?: boolean, endian?: string): number;
2562
- /**
2563
- * Read 32 bit integer
2564
- *
2565
- * @param {boolean} unsigned - if value is unsigned or not
2566
- * @param {string} endian - ```big``` or ```little```
2567
- * @returns number
2568
- */
2569
- int32(unsigned?: boolean, endian?: string): number;
2570
- /**
2571
- * Read 32 bit integer
2572
- *
2573
- * @param {boolean} unsigned - if value is unsigned or not
2574
- * @param {string} endian - ```big``` or ```little```
2575
- * @returns number
2576
- */
2577
- long(unsigned?: boolean, endian?: string): number;
2578
- /**
2579
- * Read unsigned 32 bit integer
2580
- *
2581
- * @returns number
2582
- */
2583
- readUInt(): number;
2584
- /**
2585
- * Read unsigned 32 bit integer
2586
- *
2587
- * @returns number
2588
- */
2589
- uint(): number;
2590
- /**
2591
- * Read unsigned 32 bit integer
2592
- *
2593
- * @returns number
2594
- */
2595
- udouble(): number;
2596
- /**
2597
- * Read unsigned 32 bit integer
2598
- *
2599
- * @returns number
2600
- */
2601
- uint32(): number;
2602
- /**
2603
- * Read unsigned 32 bit integer
2604
- *
2605
- * @returns number
2606
- */
2607
- ulong(): number;
2608
- /**
2609
- * Read signed 32 bit integer
2610
- *
2611
- * @returns number
2612
- */
2613
- readInt32BE(): number;
2614
- /**
2615
- * Read signed 32 bit integer
2616
- *
2617
- * @returns number
2618
- */
2619
- intbe(): number;
2620
- /**
2621
- * Read signed 32 bit integer
2622
- *
2623
- * @returns number
2624
- */
2625
- doublebe(): number;
2626
- /**
2627
- * Read signed 32 bit integer
2628
- *
2629
- * @returns number
2630
- */
2631
- int32be(): number;
2632
- /**
2633
- * Read signed 32 bit integer
2634
- *
2635
- * @returns number
2636
- */
2637
- longbe(): number;
2638
- /**
2639
- * Read unsigned 32 bit integer
2640
- *
2641
- * @returns number
2642
- */
2643
- readUInt32BE(): number;
2644
- /**
2645
- * Read unsigned 32 bit integer
2646
- *
2647
- * @returns number
2648
- */
2649
- uintbe(): number;
2650
- /**
2651
- * Read unsigned 32 bit integer
2652
- *
2653
- * @returns number
2654
- */
2655
- udoublebe(): number;
2656
- /**
2657
- * Read unsigned 32 bit integer
2658
- *
2659
- * @returns number
2660
- */
2661
- uint32be(): number;
2662
- /**
2663
- * Read unsigned 32 bit integer
2664
- *
2665
- * @returns number
2666
- */
2667
- ulongbe(): number;
2668
- /**
2669
- * Read signed 32 bit integer
2670
- *
2671
- * @returns number
2672
- */
2673
- readInt32LE(): number;
2674
- /**
2675
- * Read signed 32 bit integer
2676
- *
2677
- * @returns number
2678
- */
2679
- intle(): number;
2680
- /**
2681
- * Read signed 32 bit integer
2682
- *
2683
- * @returns number
2684
- */
2685
- doublele(): number;
2686
- /**
2687
- * Read signed 32 bit integer
2688
- *
2689
- * @returns number
2690
- */
2691
- int32le(): number;
2692
- /**
2693
- * Read signed 32 bit integer
2694
- *
2695
- * @returns number
2696
- */
2697
- longle(): number;
2698
- /**
2699
- * Read signed 32 bit integer
2700
- *
2701
- * @returns number
2702
- */
2703
- readUInt32LE(): number;
2704
- /**
2705
- * Read signed 32 bit integer
2706
- *
2707
- * @returns number
2708
- */
2709
- uintle(): number;
2710
- /**
2711
- * Read signed 32 bit integer
2712
- *
2713
- * @returns number
2714
- */
2715
- udoublele(): number;
2716
- /**
2717
- * Read signed 32 bit integer
2718
- *
2719
- * @returns number
2720
- */
2721
- uint32le(): number;
2722
- /**
2723
- * Read signed 32 bit integer
2724
- *
2725
- * @returns number
2726
- */
2727
- ulongle(): number;
2728
- /**
2729
- * Read float
2730
- *
2731
- * @param {string} endian - ```big``` or ```little```
2732
- * @returns number
2733
- */
2734
- readFloat(endian?: string): number;
2735
- /**
2736
- * Write float
2737
- *
2738
- * @param {number} value - value as int
2739
- * @param {string} endian - ``big`` or ``little`
2740
- */
2741
- writeFloat(value: number, endian?: string): void;
2742
- /**
2743
- * Read float
2744
- *
2745
- * @param {string} endian - ```big``` or ```little```
2746
- * @returns number
2747
- */
2748
- float(endian?: string): number;
2749
- /**
2750
- * Read float
2751
- *
2752
- * @returns number
2753
- */
2754
- readFloatBE(): number;
2755
- /**
2756
- * Read float
2757
- *
2758
- * @returns number
2759
- */
2760
- floatbe(): number;
2761
- /**
2762
- * Read float
2763
- *
2764
- * @returns number
2765
- */
2766
- readFloatLE(): number;
2767
- /**
2768
- * Read float
2769
- *
2770
- * @returns number
2771
- */
2772
- floatle(): number;
2773
- /**
2774
- * Read signed 64 bit integer
2775
- * @param {boolean} unsigned - if value is unsigned or not
2776
- * @param {string} endian - ```big``` or ```little```
2777
- * @returns number
2778
- */
2779
- readInt64(unsigned?: boolean, endian?: string): bigint;
2780
- /**
2781
- * Write 64 bit integer
2782
- *
2783
- * @param {number} value - value as int
2784
- * @param {boolean} unsigned - if the value is unsigned
2785
- * @param {string} endian - ``big`` or ``little`
2786
- */
2787
- writeInt64(value: number, unsigned?: boolean, endian?: string): void;
2788
- /**
2789
- * Read signed 64 bit integer
2790
- * @param {boolean} unsigned - if value is unsigned or not
2791
- * @param {string} endian - ```big``` or ```little```
2792
- * @returns number
2793
- */
2794
- int64(unsigned?: boolean, endian?: string): bigint;
2795
- /**
2796
- * Read signed 64 bit integer
2797
- * @param {boolean} unsigned - if value is unsigned or not
2798
- * @param {string} endian - ```big``` or ```little```
2799
- * @returns number
2800
- */
2801
- bigint(unsigned?: boolean, endian?: string): bigint;
2802
- /**
2803
- * Read signed 64 bit integer
2804
- * @param {boolean} unsigned - if value is unsigned or not
2805
- * @param {string} endian - ```big``` or ```little```
2806
- * @returns number
2807
- */
2808
- quad(unsigned?: boolean, endian?: string): bigint;
2809
- /**
2810
- * Read unsigned 64 bit integer
2811
- *
2812
- * @returns number
2813
- */
2814
- readUInt64(): bigint;
2815
- /**
2816
- * Read unsigned 64 bit integer
2817
- *
2818
- * @returns number
2819
- */
2820
- uint64(): bigint;
2821
- /**
2822
- * Read unsigned 64 bit integer
2823
- *
2824
- * @returns number
2825
- */
2826
- ubigint(): bigint;
2827
- /**
2828
- * Read unsigned 64 bit integer
2829
- *
2830
- * @returns number
2831
- */
2832
- uquad(): bigint;
2833
- /**
2834
- * Read signed 64 bit integer
2835
- *
2836
- * @returns number
2837
- */
2838
- readInt64BE(): bigint;
2839
- /**
2840
- * Read signed 64 bit integer
2841
- *
2842
- * @returns number
2843
- */
2844
- int64be(): bigint;
2845
- /**
2846
- * Read signed 64 bit integer
2847
- *
2848
- * @returns number
2849
- */
2850
- bigintbe(): bigint;
2851
- /**
2852
- * Read signed 64 bit integer
2853
- *
2854
- * @returns number
2855
- */
2856
- quadbe(): bigint;
2857
- /**
2858
- * Read unsigned 64 bit integer
2859
- *
2860
- * @returns number
2861
- */
2862
- readUInt64BE(): bigint;
2863
- /**
2864
- * Read unsigned 64 bit integer
2865
- *
2866
- * @returns number
2867
- */
2868
- uint64be(): bigint;
2869
- /**
2870
- * Read unsigned 64 bit integer
2871
- *
2872
- * @returns number
2873
- */
2874
- ubigintbe(): bigint;
2875
- /**
2876
- * Read unsigned 64 bit integer
2877
- *
2878
- * @returns number
2879
- */
2880
- uquadbe(): bigint;
2881
- /**
2882
- * Read signed 64 bit integer
2883
- *
2884
- * @returns number
2885
- */
2886
- readInt64LE(): bigint;
2887
- /**
2888
- * Read signed 64 bit integer
2889
- *
2890
- * @returns number
2891
- */
2892
- int64le(): bigint;
2893
- /**
2894
- * Read signed 64 bit integer
2895
- *
2896
- * @returns number
2897
- */
2898
- bigintle(): bigint;
2899
- /**
2900
- * Read signed 64 bit integer
2901
- *
2902
- * @returns number
2903
- */
2904
- quadle(): bigint;
2905
- /**
2906
- * Read unsigned 64 bit integer
2907
- *
2908
- * @returns number
2909
- */
2910
- readUInt64LE(): bigint;
2911
- /**
2912
- * Read unsigned 64 bit integer
2913
- *
2914
- * @returns number
2915
- */
2916
- uint64le(): bigint;
2917
- /**
2918
- * Read unsigned 64 bit integer
2919
- *
2920
- * @returns number
2921
- */
2922
- ubigintle(): bigint;
2923
- /**
2924
- * Read unsigned 64 bit integer
2925
- *
2926
- * @returns number
2927
- */
2928
- uquadle(): bigint;
2929
- /**
2930
- * Read double float
2931
- *
2932
- * @param {string} endian - ```big``` or ```little```
2933
- * @returns number
2934
- */
2935
- readDoubleFloat(endian?: string): number;
2936
- /**
2937
- * Writes double float
2938
- *
2939
- * @param {number} value - value as int
2940
- * @param {number} offset - byte offset (default last write position)
2941
- * @param {string} endian - ``big`` or ``little`
2942
- */
2943
- writeDoubleFloat(value: number, endian?: string): void;
2944
- /**
2945
- * Read double float
2946
- *
2947
- * @param {string} endian - ```big``` or ```little```
2948
- * @returns number
2949
- */
2950
- doublefloat(endian?: string): number;
2951
- /**
2952
- * Read double float
2953
- *
2954
- * @param {string} endian - ```big``` or ```little```
2955
- * @returns number
2956
- */
2957
- dfloat(endian?: string): number;
2958
- /**
2959
- * Read double float
2960
- *
2961
- * @returns number
2962
- */
2963
- readDoubleFloatBE(): number;
2964
- /**
2965
- * Read double float
2966
- *
2967
- * @returns number
2968
- */
2969
- dfloatebe(): number;
2970
- /**
2971
- * Read double float
2972
- *
2973
- * @returns number
2974
- */
2975
- doublefloatbe(): number;
2976
- /**
2977
- * Read double float
2978
- *
2979
- * @returns number
2980
- */
2981
- readDoubleFloatLE(): number;
2982
- /**
2983
- * Read double float
2984
- *
2985
- * @returns number
2986
- */
2987
- dfloatle(): number;
2988
- /**
2989
- * Read double float
2990
- *
2991
- * @returns number
2992
- */
2993
- doublefloatle(): number;
2994
- /**
2995
- * Reads string, use options object for different types
2996
- *
2997
- * @param {object} options
2998
- * ```javascript
2999
- * {
3000
- * length: number, //for fixed length, non-terminate value utf strings
3001
- * stringType: "utf-8", //utf-8, utf-16, pascal or wide-pascal
3002
- * terminateValue: 0x00, // only for non-fixed length utf strings
3003
- * lengthReadSize: 1, //for pascal strings. 1, 2 or 4 byte length read size
3004
- * stripNull: true, // removes 0x00 characters
3005
- * encoding: "utf-8", //TextEncoder accepted types
3006
- * endian: "little", //for wide-pascal and utf-16
3007
- * }
3008
- * ```
3009
- * @return string
3010
- */
3011
- readString(options?: {
3012
- length?: number;
3013
- stringType?: string;
3014
- terminateValue?: number;
3015
- lengthReadSize?: number;
3016
- stripNull?: boolean;
3017
- encoding?: string;
3018
- endian?: string;
3019
- }): string;
3020
- /**
3021
- * Writes string, use options object for different types
3022
- *
3023
- *
3024
- * @param {string} string - text string
3025
- * @param {object} options - options:
3026
- * ```javascript
3027
- * {
3028
- * length: string.length, //for fixed length, non-terminate value utf strings
3029
- * stringType: "utf-8", //utf-8, utf-16, pascal or wide-pascal
3030
- * terminateValue: 0x00, // only with stringType: "utf"
3031
- * lengthWriteSize: 1, //for pascal strings. 1, 2 or 4 byte length write size
3032
- * encoding: "utf-8", //TextEncoder accepted types
3033
- * endian: "little", //for wide-pascal and utf-16
3034
- * }
3035
- * ```
3036
- */
3037
- writeString(string: string, options?: {
3038
- length?: number;
3039
- stringType?: string;
3040
- terminateValue?: number;
3041
- lengthWriteSize?: number;
3042
- stripNull?: boolean;
3043
- encoding?: string;
3044
- endian?: string;
3045
- }): void;
3046
- /**
3047
- * Reads string, use options object for different types
3048
- *
3049
- * @param {object} options
3050
- * ```javascript
3051
- * {
3052
- * length: number, //for fixed length, non-terminate value utf strings
3053
- * stringType: "utf-8", //utf-8, utf-16, pascal or wide-pascal
3054
- * terminateValue: 0x00, // only for non-fixed length utf strings
3055
- * lengthReadSize: 1, //for pascal strings. 1, 2 or 4 byte length read size
3056
- * stripNull: true, // removes 0x00 characters
3057
- * encoding: "utf-8", //TextEncoder accepted types
3058
- * endian: "little", //for wide-pascal and utf-16
3059
- * }
3060
- * ```
3061
- * @return string
3062
- */
3063
- string(options?: {
3064
- length?: number;
3065
- stringType?: string;
3066
- terminateValue?: number;
3067
- lengthReadSize?: number;
3068
- stripNull?: boolean;
3069
- encoding?: string;
3070
- endian?: string;
3071
- }): string;
3072
- /**
3073
- * Reads UTF-8 (C) string
3074
- *
3075
- * @param {number} length - for fixed length utf strings
3076
- * @param {number} terminateValue - for non-fixed length utf strings
3077
- * @param {boolean} stripNull - removes 0x00 characters
3078
- *
3079
- * @return string
3080
- */
3081
- utf8string(length?: number, terminateValue?: number, stripNull?: boolean): string;
3082
- /**
3083
- * Reads UTF-8 (C) string
3084
- *
3085
- * @param {number} length - for fixed length utf strings
3086
- * @param {number} terminateValue - for non-fixed length utf strings
3087
- * @param {boolean} stripNull - removes 0x00 characters
3088
- *
3089
- * @return string
3090
- */
3091
- cstring(length?: number, terminateValue?: number, stripNull?: boolean): string;
3092
- /**
3093
- * Reads ANSI string
3094
- *
3095
- * @param {number} length - for fixed length utf strings
3096
- * @param {number} terminateValue - for non-fixed length utf strings
3097
- * @param {boolean} stripNull - removes 0x00 characters
3098
- *
3099
- * @return string
3100
- */
3101
- ansistring(length?: number, terminateValue?: number, stripNull?: boolean): string;
3102
- /**
3103
- * Reads UTF-16 (Unicode) string
3104
- *
3105
- * @param {number} length - for fixed length utf strings
3106
- * @param {number} terminateValue - for non-fixed length utf strings
3107
- * @param {boolean} stripNull - removes 0x00 characters
3108
- * @param {string} endian - ``big`` or ``little``
3109
- *
3110
- * @return string
3111
- */
3112
- utf16string(length?: number, terminateValue?: number, stripNull?: boolean, endian?: string): string;
3113
- /**
3114
- * Reads UTF-16 (Unicode) string
3115
- *
3116
- * @param {number} length - for fixed length utf strings
3117
- * @param {number} terminateValue - for non-fixed length utf strings
3118
- * @param {boolean} stripNull - removes 0x00 characters
3119
- * @param {string} endian - ``big`` or ``little``
3120
- *
3121
- * @return string
3122
- */
3123
- unistring(length?: number, terminateValue?: number, stripNull?: boolean, endian?: string): string;
3124
- /**
3125
- * Reads UTF-16 (Unicode) string in little endian order
3126
- *
3127
- * @param {number} length - for fixed length utf strings
3128
- * @param {number} terminateValue - for non-fixed length utf strings
3129
- * @param {boolean} stripNull - removes 0x00 characters
3130
- *
3131
- * @return string
3132
- */
3133
- utf16stringle(length?: number, terminateValue?: number, stripNull?: boolean): string;
3134
- /**
3135
- * Reads UTF-16 (Unicode) string in little endian order
3136
- *
3137
- * @param {number} length - for fixed length utf strings
3138
- * @param {number} terminateValue - for non-fixed length utf strings
3139
- * @param {boolean} stripNull - removes 0x00 characters
3140
- *
3141
- * @return string
3142
- */
3143
- unistringle(length?: number, terminateValue?: number, stripNull?: boolean): string;
3144
- /**
3145
- * Reads UTF-16 (Unicode) string in big endian order
3146
- *
3147
- * @param {number} length - for fixed length utf strings
3148
- * @param {number} terminateValue - for non-fixed length utf strings
3149
- * @param {boolean} stripNull - removes 0x00 characters
3150
- *
3151
- * @return string
3152
- */
3153
- utf16stringbe(length?: number, terminateValue?: number, stripNull?: boolean): string;
3154
- /**
3155
- * Reads UTF-16 (Unicode) string in big endian order
3156
- *
3157
- * @param {number} length - for fixed length utf strings
3158
- * @param {number} terminateValue - for non-fixed length utf strings
3159
- * @param {boolean} stripNull - removes 0x00 characters
3160
- *
3161
- * @return string
3162
- */
3163
- unistringbe(length?: number, terminateValue?: number, stripNull?: boolean): string;
3164
- /**
3165
- * Reads Pascal string
3166
- *
3167
- * @param {number} lengthReadSize - 1, 2 or 4 byte length write size (default 1)
3168
- * @param {boolean} stripNull - removes 0x00 characters
3169
- * @param {string} endian - ``big`` or ``little``
3170
- *
3171
- * @return string
3172
- */
3173
- pstring(lengthReadSize?: number, stripNull?: boolean, endian?: string): string;
3174
- /**
3175
- * Reads Pascal string 1 byte length read
3176
- *
3177
- * @param {boolean} stripNull - removes 0x00 characters
3178
- * @param {string} endian - ``big`` or ``little``
3179
- *
3180
- * @return string
3181
- */
3182
- pstring1(stripNull?: boolean, endian?: string): string;
3183
- /**
3184
- * Reads Pascal string 1 byte length read in little endian order
3185
- *
3186
- * @param {boolean} stripNull - removes 0x00 characters
3187
- *
3188
- * @return string
3189
- */
3190
- pstring1le(stripNull?: boolean): string;
3191
- /**
3192
- * Reads Pascal string 1 byte length read in big endian order
3193
- *
3194
- * @param {boolean} stripNull - removes 0x00 characters
3195
- *
3196
- * @return string
3197
- */
3198
- pstring1be(stripNull?: boolean): string;
3199
- /**
3200
- * Reads Pascal string 2 byte length read
3201
- *
3202
- * @param {boolean} stripNull - removes 0x00 characters
3203
- * @param {string} endian - ``big`` or ``little``
3204
- *
3205
- * @return string
3206
- */
3207
- pstring2(stripNull?: boolean, endian?: string): string;
3208
- /**
3209
- * Reads Pascal string 2 byte length read in little endian order
3210
- *
3211
- * @param {boolean} stripNull - removes 0x00 characters
3212
- *
3213
- * @return string
3214
- */
3215
- pstring2le(stripNull?: boolean): string;
3216
- /**
3217
- * Reads Pascal string 2 byte length read in big endian order
3218
- *
3219
- * @param {boolean} stripNull - removes 0x00 characters
3220
- *
3221
- * @return string
3222
- */
3223
- pstring2be(stripNull?: boolean): string;
3224
- /**
3225
- * Reads Pascal string 4 byte length read
3226
- *
3227
- * @param {boolean} stripNull - removes 0x00 characters
3228
- * @param {string} endian - ``big`` or ``little``
3229
- *
3230
- * @return string
3231
- */
3232
- pstring4(stripNull?: boolean, endian?: string): string;
3233
- /**
3234
- * Reads Pascal string 4 byte length read in little endian order
3235
- *
3236
- * @param {boolean} stripNull - removes 0x00 characters
3237
- *
3238
- * @return string
3239
- */
3240
- pstring4le(stripNull?: boolean): string;
3241
- /**
3242
- * Reads Pascal string 4 byte length read in big endian order
3243
- *
3244
- * @param {boolean} stripNull - removes 0x00 characters
3245
- *
3246
- * @return string
3247
- */
3248
- pstring4be(stripNull?: boolean): string;
3249
- /**
3250
- * Reads Wide-Pascal string
3251
- *
3252
- * @param {number} lengthReadSize - 1, 2 or 4 byte length write size (default 1)
3253
- * @param {boolean} stripNull - removes 0x00 characters
3254
- * @param {string} endian - ``big`` or ``little``
3255
- *
3256
- * @return string
3257
- */
3258
- wpstring(lengthReadSize?: number, stripNull?: boolean, endian?: string): string;
3259
- /**
3260
- * Reads Wide-Pascal string 1 byte length read
3261
- *
3262
- * @param {boolean} stripNull - removes 0x00 characters
3263
- * @param {string} endian - ``big`` or ``little``
3264
- *
3265
- * @return string
3266
- */
3267
- wpstring1(stripNull?: boolean, endian?: string): string;
3268
- /**
3269
- * Reads Wide-Pascal string 2 byte length read
3270
- *
3271
- * @param {boolean} stripNull - removes 0x00 characters
3272
- * @param {string} endian - ``big`` or ``little``
3273
- *
3274
- * @return string
3275
- */
3276
- wpstring2(stripNull?: boolean, endian?: string): string;
3277
- /**
3278
- * Reads Wide-Pascal string 2 byte length read in little endian order
3279
- *
3280
- * @param {boolean} stripNull - removes 0x00 characters
3281
- *
3282
- * @return string
3283
- */
3284
- wpstring2le(stripNull?: boolean): string;
3285
- /**
3286
- * Reads Wide-Pascal string 2 byte length read in big endian order
3287
- *
3288
- * @param {boolean} stripNull - removes 0x00 characters
3289
- *
3290
- * @return string
3291
- */
3292
- wpstring2be(stripNull?: boolean): string;
3293
- /**
3294
- * Reads Wide-Pascal string 4 byte length read
3295
- *
3296
- * @param {boolean} stripNull - removes 0x00 characters
3297
- * @param {string} endian - ``big`` or ``little``
3298
- *
3299
- * @return string
3300
- */
3301
- wpstring4(stripNull?: boolean, endian?: string): string;
3302
- /**
3303
- * Reads Wide-Pascal string 4 byte length read in big endian order
3304
- *
3305
- * @param {boolean} stripNull - removes 0x00 characters
3306
- *
3307
- * @return string
3308
- */
3309
- wpstring4be(stripNull?: boolean): string;
3310
- /**
3311
- * Reads Wide-Pascal string 4 byte length read in little endian order
3312
- *
3313
- * @param {boolean} stripNull - removes 0x00 characters
3314
- *
3315
- * @return string
3316
- */
3317
- wpstring4le(stripNull?: boolean): string;
3318
- }
3319
- //# sourceMappingURL=reader.d.ts.map