Skip to content
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

Extend file system provider interface #1784

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

msujew
Copy link
Member

@msujew msujew commented Jan 8, 2025

Extends the file system provider to have the common file system operations:

  1. Reading text file
  2. Reading directory
  3. Reading binary file
  4. Checking whether a file exists

Both of these are now available in their respective sync and async versions. However, the framework itself exclusively uses the async methods. The sync method is available for adopters.

This change required to update the @types/node dev dependency to 18, as the Buffer class only started to correctly subtypethe Uint8Array class during that release.

@msujew
Copy link
Member Author

msujew commented Jan 14, 2025

cc @cdietrich I believe you were interested in sync fs methods, right?

@cdietrich
Copy link
Contributor

yes

Copy link
Contributor

@spoenemann spoenemann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the new interface methods are not optional, we should regard this as a breaking change.

@spoenemann spoenemann added this to the v4.0.0 milestone Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants