Skip to content

Commit

Permalink
docs(core): document delete and additional TODOs for rimraf and mkdirp
Browse files Browse the repository at this point in the history
  • Loading branch information
bericp1 committed Apr 5, 2019
1 parent 82b3d72 commit a5f6eda
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Expand Up @@ -157,6 +157,7 @@ Important public methods:
- `async createReadStream(path: string): Promise<Readable>` to obtain a readable stream to a file
- `async write(path: string, contents: Buffer): Promise<void>` to write to a file
- `async createReadStream(path: string): Promise<Writable>` to obtain a writable stream to a file
- `async delete(path: string): Promise<void>` to delete a file (not a directory)
- `async list(path: string): Promise<DiskListingObject[]>` to obtain a list of objects in a
directory on the disk.

Expand All @@ -180,6 +181,8 @@ for inline documentation and types.
- [ ] Don't rely on `fs.readdir`'s `withFileTypes` so as to support all node 10 versions
- [ ] Write a `MemoryVolumeDisk` driver
- [ ] Fix the `MemoryDisk` driver to accept and honor `root` like the `LocalDisk` does.
- [ ] Support `rimraf` for directories
- [ ] Fix `FSDisk` (backend to `MemoryDisk` and `LocalDisk`) to `mkdirp` path to file to mirror s3 behaviour

## Development

Expand Down

0 comments on commit a5f6eda

Please sign in to comment.