zephyr.js icon indicating copy to clipboard operation
zephyr.js copied to clipboard

[fs] Please complete FS APIs on fs.md

Open cuiyanx opened this issue 7 years ago • 4 comments

Description

I find FS APIs can not be completed in /docs/fs.md, there are just only one interface for state. And there is no function for /samples/FsAsync.js. Will we add it? If not, please remove it.

Test Code

/docs/fs.md /samples/FsAsync.js

Steps to Reproduction

Actual Result

Not be completed.

Expected Result

Be finished.

Test Builds

Branch Commit Id Target Device Test Date Result
master 15d38476 Arduino 101 June 21, 2017 Fail

Additional Information

cuiyanx avatar Jun 21 '17 02:06 cuiyanx

I think this is saying the documentation is incomplete. The IDL portion doesn't include most of the APIs, and the Async APIs are left out.

The latter bit was intentional - we weren't sure if we really intend to support them; they are there for backwards compatibility but not really meant to be used for new code.

grgustaf avatar Jun 21 '17 22:06 grgustaf

@grgustaf , FsAync.js sample can't be executed successfully on A101 now. selection_056

qiaojingx avatar Jun 23 '17 06:06 qiaojingx

"there are just only one interface for state" @cuiyanx, can you tell me what that meant? The missing async docs is not high-priority, since that's intentional but I wonder if this is more important?

grgustaf avatar Jan 24 '18 17:01 grgustaf

@grgustaf We had some APIs for synchronous situation and none for asynchronous situation. But we have sample for asynchronous situation. We maybe need to add APIs for asynchronous situation to fs doc, or remove this sample. I think that is my thought.

cuiyanx avatar Jan 25 '18 02:01 cuiyanx