1 | # Change Log
|
2 | ## 4.1.0
|
3 | > Released 07/24/2019
|
4 | * Adds int64 support for node v12+
|
5 | * Drops support for node v4
|
6 |
|
7 | ## 4.0
|
8 | > Released 10/21/2017
|
9 | * Major breaking changes arriving in v4.
|
10 |
|
11 | ### New Features
|
12 | * Ability to read data from a specific offset. ex: readInt8(5)
|
13 | * Ability to write over data when an offset is given (see breaking changes) ex: writeInt8(5, 0);
|
14 | * Ability to set internal read and write offsets.
|
15 |
|
16 |
|
17 |
|
18 | ### Breaking Changes
|
19 |
|
20 | * Old constructor patterns have been completely removed. It's now required to use the SmartBuffer.fromXXX() factory constructors. Read more on the v4 docs.
|
21 | * rewind(), skip(), moveTo() have been removed.
|
22 | * Internal private properties are now prefixed with underscores (_).
|
23 | * **All** writeXXX() methods that are given an offset will now **overwrite data** instead of insert
|
24 | * insertXXX() methods have been added for when you want to insert data at a specific offset (this replaces the old behavior of writeXXX() when an offset was provided)
|
25 |
|
26 |
|
27 | ### Other Changes
|
28 | * Standardizd error messaging
|
29 | * Standardized offset/length bounds and sanity checking
|
30 | * General overall cleanup of code.
|
31 |
|
32 | ## 3.0.3
|
33 | > Released 02/19/2017
|
34 | * Adds missing type definitions for some internal functions.
|
35 |
|
36 | ## 3.0.2
|
37 | > Released 02/17/2017
|
38 |
|
39 | ### Bug Fixes
|
40 | * Fixes a bug where using readString with a length of zero resulted in reading the remaining data instead of returning an empty string. (Fixed by Seldszar)
|
41 |
|
42 | ## 3.0.1
|
43 | > Released 02/15/2017
|
44 |
|
45 | ### Bug Fixes
|
46 | * Fixes a bug leftover from the TypeScript refactor where .readIntXXX() resulted in .readUIntXXX() being called by mistake.
|
47 |
|
48 | ## 3.0
|
49 | > Released 02/12/2017
|
50 |
|
51 | ### Bug Fixes
|
52 | * readUIntXXXX() methods will now throw an exception if they attempt to read beyond the bounds of the valid buffer data available.
|
53 | * **Note** This is technically a breaking change, so version is bumped to 3.x.
|
54 |
|
55 | ## 2.0
|
56 | > Relased 01/30/2017
|
57 |
|
58 | ### New Features:
|
59 |
|
60 | * Entire package re-written in TypeScript (2.1)
|
61 | * Backwards compatibility is preserved for now
|
62 | * New factory methods for creating SmartBuffer instances
|
63 | * SmartBuffer.fromSize()
|
64 | * SmartBuffer.fromBuffer()
|
65 | * SmartBuffer.fromOptions()
|
66 | * New SmartBufferOptions constructor options
|
67 | * Added additional tests
|
68 |
|
69 | ### Bug Fixes:
|
70 | * Fixes a bug where reading null terminated strings may result in an exception.
|