Skip to content

Commit 5e7d3a3

Browse files
committed
Updated module descriptions
1 parent 9395027 commit 5e7d3a3

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

core/Module.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,6 @@ fun Message.Companion.fromBson(source: Source): Message {
7979

8080
Core IO primitives.
8181

82-
# Package kotlinx.io.files
83-
84-
Basic API for working with files.
85-
8682
#### Thread-safety guarantees
8783

8884
Until stated otherwise, types and functions provided by the library are not thread safe.
89-
90-
#### Known issues
91-
92-
- [#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,
93-
as `fd_readdir` function is [not implemented there](https://github.com/nodejs/node/blob/6f4d6011ea1b448cf21f5d363c44e4a4c56ca34c/deps/uvwasi/src/uvwasi.c#L19).

filesystem/Module.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Module kotlinx-io-filesystem
2+
3+
The module provides experimental files and filesystem support. The API is unstable and will change in the future.
4+
5+
# Package kotlinx.io.files
6+
7+
Basic API for working with files.
8+
9+
#### Thread-safety guarantees
10+
11+
Until stated otherwise, types and functions provided by the library are not thread safe.
12+
13+
#### Known issues
14+
15+
[//]: <> (TODO: Link to SystemFileSystem doesn't work)
16+
- For JS and Wasm, [kotlinx.io.files.SystemFileSystem] is supported only in the NodeJs environment. Attempts to use it
17+
in the browser environment will result in a runtime error.
18+
- [#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,
19+
as `fd_readdir` function is [not implemented there](https://github.com/nodejs/node/blob/6f4d6011ea1b448cf21f5d363c44e4a4c56ca34c/deps/uvwasi/src/uvwasi.c#L19).

0 commit comments

Comments
 (0)