-
-
Notifications
You must be signed in to change notification settings - Fork 32
docs: FileSystem #42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: FileSystem #42
Conversation
@rigor789 I think we should provide an explanation about the difference between |
content/guide/core/file-system.md
Outdated
``` | ||
### Check if a file exists | ||
|
||
To check if a file exists, call the static [exists](#exists) method of the File class and pass it the file path string: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo.
"pass it the file path string"
Should be "pass it to the file path stored in a string"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it should be "pass it the file path as a string"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"pass the method the file path as a string"
No confusion that way.
Thank you @SeanKelly369 . |
content/guide/core/file-system.md
Outdated
``` | ||
### Check if a file exists | ||
|
||
To check if a file exists, call the static [exists](#exists) method of the File class and pass it the file path string: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"pass the method the file path as a string"
No confusion that way.
content/guide/core/file-system.md
Outdated
description: Work with the device file system | ||
--- | ||
|
||
The FileSystem module provides high-level abstractions for file system entities such as files, folders, known folders( the entry to the device file system), paths, separators, etc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The FileSystem module offers easy-to-use tools for working with files and folders in a computer's file system. It provides helpful functions for managing files, folders, paths, and separators, etc.
content/guide/core/file-system.md
Outdated
}) | ||
|
||
``` | ||
- To read data from a text file, use the `readText` or `readTextSync` method of the file instance: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about something less dry, such as this ->
To extract data from a text file, you can use the readText or readTextSync method of the file instance. Here's an example of how to use it:
|
||
### Normalizing a path | ||
|
||
To normalize a path use the `normalize` or create the path with the `join` method from the [path](#path-operations) object: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it worthwhile mentioning what normalizing a path means?
Co-authored-by: Nathan Walker <walkerrunpdx@gmail.com>
Co-authored-by: Nathan Walker <walkerrunpdx@gmail.com>
Co-authored-by: Nathan Walker <walkerrunpdx@gmail.com>
No description provided.