emscripten-core / emscripten-core/emscripten

Bug in page:Advanced APIs

Open
#23,253 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
27.6k
Forks
3.6k
Avg merge
1d 1h
Merged PRs (30d)
105

Description

Section "Advanced File System API" have no explanation for every method.

I working on implementing my own file system, and i can't understand what to do, because documentation do not have API description.

For example i've checked [MEMFS implementation](https://github.com/emscripten-core/emscripten/blob/main/src/library_memfs.js#L241) and i want to understand what a `FS.createNode` call do, i go to https://emscripten.org/docs/api_reference/advanced-apis.html#FS.createNode but there are no any elaboration what this method do.

URL: [../../docs/api_reference/advanced-apis](https://emscripten.org/docs/api_reference/Filesystem-API.html#filesystem-api)

![image](https://github.com/user-attachments/assets/72684960-2771-4e10-8cff-bdbe5a9347b8)

# Proposal

Explain what every method do and optionally add short description how to implement own file system and examples if possible

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.