Skip to content

Commit

Permalink
Updated module descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
fzhinkin committed Nov 26, 2024
1 parent 09ee6f0 commit 558d903
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 9 deletions.
9 changes: 0 additions & 9 deletions core/Module.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,6 @@ fun Message.Companion.fromBson(source: Source): Message {

Core IO primitives.

# Package kotlinx.io.files

Basic API for working with files.

#### Thread-safety guarantees

Until stated otherwise, types and functions provided by the library are not thread safe.

#### Known issues

- [#312](https://github.com/Kotlin/kotlinx-io/issues/312) For `wasmWasi` target, directory listing ([kotlinx.io.files.FileSystem.list]) does not work with NodeJS runtime on Windows,
as `fd_readdir` function is [not implemented there](https://github.com/nodejs/node/blob/6f4d6011ea1b448cf21f5d363c44e4a4c56ca34c/deps/uvwasi/src/uvwasi.c#L19).
19 changes: 19 additions & 0 deletions filesystem/Module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Module kotlinx-io-filesystem

The module provides experimental files and filesystem support. The API is unstable and will change in the future.

# Package kotlinx.io.files

Basic API for working with files.

#### Thread-safety guarantees

Until stated otherwise, types and functions provided by the library are not thread safe.

#### Known issues

[//]: <> (TODO: Link to SystemFileSystem doesn't work)
- For JS and Wasm, [kotlinx.io.files.SystemFileSystem] is supported only in the NodeJs environment. Attempts to use it
in the browser environment will result in a runtime error.
- [#312](https://github.com/Kotlin/kotlinx-io/issues/312) For `wasmWasi` target, directory listing ([kotlinx.io.files.FileSystem.list]) does not work with NodeJS runtime on Windows,
as `fd_readdir` function is [not implemented there](https://github.com/nodejs/node/blob/6f4d6011ea1b448cf21f5d363c44e4a4c56ca34c/deps/uvwasi/src/uvwasi.c#L19).

0 comments on commit 558d903

Please sign in to comment.