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

Editorial review: Add information on file system access locking modes #35334

Merged

Conversation

chrisdavidmills
Copy link
Contributor

Description

Chrome 121 supports a mode property on the options objects that can be specified as arguments to FileSystemFileHandle.createSyncAccessHandle() and FileSystemFileHandle.createWritable(). See the associated ChromeStatus entry. This PR adds content to explain these new features.

These features are not yet in the FileSystem API spec — see whatwg/fs#151 for the relevant PR. Consequently, I have marked them as non-standard in the associated docs.

See also the New Locking Scheme to Enable Multiple Readers and Writers explainer for more information on how it works.

Motivation

Additional details

Related issues and pull requests

Fixes mdn/mdn#479

@chrisdavidmills chrisdavidmills requested a review from a team as a code owner August 6, 2024 12:23
@chrisdavidmills chrisdavidmills requested review from sideshowbarker and removed request for a team August 6, 2024 12:23
@github-actions github-actions bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Aug 6, 2024
@chrisdavidmills chrisdavidmills removed the request for review from sideshowbarker August 6, 2024 12:24
Copy link
Contributor

github-actions bot commented Aug 6, 2024

Preview URLs

Flaws (1)

Note! 2 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/FileSystemFileHandle/createSyncAccessHandle
Title: FileSystemFileHandle: createSyncAccessHandle() method
Flaw count: 1

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/DataView
External URLs (2)

URL: /en-US/docs/Web/API/FileSystemFileHandle/createSyncAccessHandle
Title: FileSystemFileHandle: createSyncAccessHandle() method


URL: /en-US/docs/Web/API/FileSystemFileHandle/createWritable
Title: FileSystemFileHandle: createWritable() method

(comment last updated: 2024-08-09 09:24:44)

Copy link
Contributor

@tomayac tomayac left a comment

Choose a reason for hiding this comment

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

Just some minor nits here and there.

Copy link

@nathanmemmott nathanmemmott left a comment

Choose a reason for hiding this comment

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

Overall, the technical parts look correct to me.

@chrisdavidmills
Copy link
Contributor Author

Thanks again for the technical review, @tomayac and @nathanmemmott. At this point, it looks like all your comments have been fixed, and I'm going to take the liberty of calling this tech review closed and move this on to the editorial review stage. Feel free to add further comments if needed.

@chrisdavidmills chrisdavidmills changed the title Add information on file system access locking modes Editorial review: Add information on file system access locking modes Aug 9, 2024
@sideshowbarker sideshowbarker merged commit 2cba64f into mdn:main Aug 9, 2024
8 checks passed
@chrisdavidmills chrisdavidmills deleted the file-system-access-readwrite-modes branch August 9, 2024 18:07
@chrisdavidmills
Copy link
Contributor Author

Awesome, cheers @sideshowbarker!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add new "mode" option to FileSystemAccessFileHandle's createSyncAccessHandle and createWritable
4 participants