UNPKG

4.43 kBMarkdownView Raw
1# fs-capacitor changelog
2
3## 1.0.0
4
5- Initial release.
6
7### 1.0.1
8
9- Use default fs flags and mode
10
11## 2.0.0
12
13- Update dependencies.
14- Add tests for special stream scenarios.
15- **BREAKING:** Remove special handling of terminating events, see [jaydenseric/graphql-upload#131](https://github.com/jaydenseric/graphql-upload/issues/131)
16
17### 2.0.1
18
19- Update dependencies.
20- Move configs out of package.json
21- Use `wx` file flag instead of default `w` (thanks to @mattbretl via #8)
22
23### 2.0.2
24
25- Update dev dependencies.
26- Fix mjs structure to work with node v12.
27- Fix a bug that would pause consumption of read streams until completion. (thanks to @Nikosmonaut's investigation in #9).
28
29### 2.0.3
30
31- Emit write event _after_ bytes have been written to the filesystem.
32
33### 2.0.4
34
35- Revert support for Node.js v12 `--experimental-modules` mode that was published in [v2.0.2](https://github.com/mike-marcacci/fs-capacitor/releases/tag/v2.0.2) that broke compatibility with earlier Node.js versions and test both ESM and CJS builds (skipping `--experimental-modules` tests for Node.js v12), via [#11](https://github.com/mike-marcacci/fs-capacitor/pull/11).
36- Use package `browserslist` field instead of configuring `@babel/preset-env` directly.
37- Configure `@babel/preset-env` to use shipped proposals and loose mode.
38- Give dev tool config files `.json` extensions so they can be Prettier linted.
39- Don't Prettier ignore the `lib` directory; it's meant to be pretty.
40- Prettier ignore `package.json` and `package-lock.json` so npm can own the formatting.
41- Configure [`eslint-plugin-node`](https://npm.im/eslint-plugin-node) to resolve `.mjs` before `.js` and other extensions, for compatibility with the pre Node.js v12 `--experimental-modules` behavior.
42- Don't ESLint ignore `node_modules`, as it's already ignored by default.
43- Use the `classic` TAP reporter for tests as it has more compact output.
44
45## 3.0.0
46
47- Update dev dependencies.
48- Add support for Node.js v13 by no longer extending `ReadStream` and `WriteStream` from node's `fs` library.
49- Specify `0o600` for buffer file permissions instead of node's default `0o666`
50- **BREAKING:** Remove several undocumented properties that existed for consistency with the extended classes.
51- **BREAKING:** No longer listen for `SIGINT`, and instead warn the application to add handlers for terminating signals.
52
53## 4.0.0
54
55- Update source to typescript.
56- Add `WriteStream.release` replacing the functionality of an error-free `WriteStream.destroy()`
57- **BREAKING:** Change `WriteStream.destroy()` to immediately destroy attached `ReadStream`s even without an error.
58- **BREAKING:** Reluctantly remove exported `.mjs` files now that we have an external commonjs dependency and are still missing clear interop guidance from node.
59
60### 4.0.1
61
62- Add cleanup example to README.md
63- Remove warnings about signal listeners.
64
65## 5.0.0
66
67- Update dev dependencies.
68- Remove dependency on `readable-stream` to expose new (but internally unused) features of streams in node v13.
69- **BREAKING:** Remove support for node v8.
70
71### 5.0.1
72
73- Add cleanup example to README.md
74- Remove warnings about signal listeners.
75
76## 6.0.0
77
78- Update dev dependencies.
79- Add the ability to specify encoding and highWaterMark in `createReadStream()`.
80- **BREAKING:** Remove "name" argument from `createReadStream()`.
81
82### 6.1.0
83
84- Add the ability to specify defaultEncoding and highWaterMark in `new WriteStream()`.
85- Export `ReadStreamOptions` and `WriteStreamOptions` interfaces.
86- Add tests for highWaterMark option in `createReadStream`.
87- Add documentation of configuration options to README.
88
89### 6.2.0
90
91- Upgrade dependencies.
92- Update option types to match changes in @types/node.
93
94### 7.0.0
95
96- Upgrade dependencies.
97- Prevent Node.js max listeners exceeded warnings if many `fs-capacitor` `ReadStream` instances are created at the same time, fixing [#30](https://github.com/mike-marcacci/fs-capacitor/issues/30) via [#42](https://github.com/mike-marcacci/fs-capacitor/pull/42).
98- Ensure initialization failures are reported, fixing [#45](https://github.com/mike-marcacci/fs-capacitor/issues/45) via [#46](https://github.com/mike-marcacci/fs-capacitor/pull/46/files).
99- **BREAKING:** Drop support for node 13.
100- **BREAKING:** Drop support for node 10.
101- **BREAKING:** Change module type to ES module.
102
103### 7.0.1
104
105- Publish TS definitions and map via [#54](https://github.com/mike-marcacci/fs-capacitor/pull/54).