doc: add note about Promise detection in README.md and update API status

streamich · Nov 7, 2018 · 3e8d2d4 · 3e8d2d4
1 parent 4750aee
commit 3e8d2d4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -118,6 +118,9 @@ This package depends on the following Node modules: `buffer`, `events`,
 It also uses `process` and `setImmediate` globals, but mocks them, if not
 available.
 
+It uses `Promise` when available and throws when `promises` property is
+accessed in an environment that do not support this ES2015 feature.
+
 [npm-url]: https://www.npmjs.com/package/memfs
 [npm-badge]: https://img.shields.io/npm/v/memfs.svg
 [travis-url]: https://travis-ci.org/streamich/memfs

diff --git a/docs/api-status.md b/docs/api-status.md
@@ -4,7 +4,7 @@ All of the [Node's `fs` API](https://nodejs.org/api/fs.html) is implemented.
 Some error messages may be inaccurate. File permissions are currently not
 implemented (you have access to any file), basically `fs.access()` is a no-op.
 
-  - [ ] Promises
+  - [x] Promises
   - [x] Constants
   - [x] `FSWatcher`
   - [x] `ReadStream`