Skip to content

Align status of Entries API docs with implementation reality #8379

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Aug 27, 2021
Merged

Align status of Entries API docs with implementation reality #8379

merged 1 commit into from
Aug 27, 2021

Conversation

sideshowbarker
Copy link
Member

For all articles for features of the File and Directory Entries API, this change drops all flags and statements indicating the API is deprecated, non-standard, or experimental. Fixes #8263.

The API has now been implemented and shipped for a long time now in all current browser engines — so at this point it’s not helpful to developers to warn them about it being unstable or non-standard.

This change also makes a variety of other changes to align with the current specification — including:

  • replacing references to the obsolete FileError object with references to the DOMException object instead

  • dropping any mentions of the former parts of the specification that had to do with writing (creating) files (the current spec only defines an API for reading files)

And the change also includes some fixes to un-conflate the File and Directory Entries API from the previous, ancient, non-standard File System API.

@sideshowbarker sideshowbarker requested a review from a team August 27, 2021 06:24
@sideshowbarker sideshowbarker requested a review from a team as a code owner August 27, 2021 06:24
@sideshowbarker sideshowbarker force-pushed the sideshowbarker/file_and_directory_entries_api-status-update branch from 3817142 to c20dc1f Compare August 27, 2021 06:24
@github-actions
Copy link
Contributor

github-actions bot commented Aug 27, 2021 •
edited
Loading

Preview URLs

Flaws

None! 🎉

External URLs

URL: /en-US/docs/Web/API/File_and_Directory_Entries_API
Title: File and Directory Entries API
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/File_and_Directory_Entries_API/Introduction
Title: Introduction to the File and Directory Entries API
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/File_and_Directory_Entries_API/Firefox_support
Title: File and Directory Entries API support in Firefox
on GitHub

URL: /en-US/docs/Web/API/FileSystemDirectoryReader
Title: FileSystemDirectoryReader
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemDirectoryReader/readEntries
Title: FileSystemDirectoryReader.readEntries()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemEntry
Title: FileSystemEntry
on GitHub

URL: /en-US/docs/Web/API/FileSystemEntry/isDirectory
Title: FileSystemEntry.isDirectory
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemEntry/name
Title: FileSystemEntry.name
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemEntry/fullPath
Title: FileSystemEntry.fullPath
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemEntry/isFile
Title: FileSystemEntry.isFile
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemEntry/getParent
Title: FileSystemEntry.getParent()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemEntry/toURL
Title: FileSystemEntry.toURL()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemEntry/filesystem
Title: FileSystemEntry.filesystem
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemDirectoryEntry
Title: FileSystemDirectoryEntry
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemDirectoryEntry/createReader
Title: FileSystemDirectoryEntry.createReader()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemDirectoryEntry/getDirectory
Title: FileSystemDirectoryEntry.getDirectory()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemDirectoryEntry/getFile
Title: FileSystemDirectoryEntry.getFile()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemFlags
Title: FileSystemFlags
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemFlags/exclusive
Title: FileSystemFlags.exclusive
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemFlags/create
Title: FileSystemFlags.create
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemFileEntry
Title: FileSystemFileEntry
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystemFileEntry/file
Title: FileSystemFileEntry.file()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystem
Title: FileSystem
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystem/name
Title: FileSystem.name
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileSystem/root
Title: FileSystem.root
on GitHub

No new external URLs

(this comment was updated 2021-08-27 06:31:27.906336)

@sideshowbarker sideshowbarker force-pushed the sideshowbarker/file_and_directory_entries_api-status-update branch from c20dc1f to 62bb245 Compare August 27, 2021 06:27
@sideshowbarker
Align status of Entries API docs with implementation reality
dc1cf8d 
For all articles for features of the File and Directory Entries API,
this change drops all flags and statements indicating the API is
deprecated, non-standard, or experimental.

The API has now been implemented and shipped for a long time now in all
current browser engines — so at this point it’s not helpful to
developers to warn them about it being unstable or non-standard.

This change also makes a variety of other changes to align with the
current specification — including:

- replacing references to the obsolete FileError object with references
   to the DOMException object instead

- dropping any mentions of the former parts of the specification that
  had to do with writing (creating) files (the current spec only defines
  an API for reading files)

- dropping any mentions of the former parts of the specification that
  defines synchronous equivalents for some of the API members

And the change also includes some fixes to un-conflate the File and
Directory Entries API from the previous, ancient, non-standard File
System API.

Fixes #8263
@sideshowbarker sideshowbarker force-pushed the sideshowbarker/file_and_directory_entries_api-status-update branch from 62bb245 to dc1cf8d Compare August 27, 2021 06:29
@sideshowbarker sideshowbarker mentioned this pull request Aug 27, 2021
Closed
@teoli2003 teoli2003 merged commit 85c064e into main Aug 27, 2021
@teoli2003 teoli2003 deleted the sideshowbarker/file_and_directory_entries_api-status-update branch August 27, 2021 06:51
sideshowbarker added a commit to sideshowbarker/browser-compat-data that referenced this pull request Sep 3, 2021
@sideshowbarker
Un-deprecate FileSystemDirectoryReader
eb14fbf 
FileSystemDirectoryReader should never have been marked at deprecated.
See mdn/content#8263 and see the spec at
https://wicg.github.io/entries-api/#api-directoryreader

Related MDN PR: mdn/content#8379
@sideshowbarker sideshowbarker mentioned this pull request Sep 3, 2021
Merged
queengooborg pushed a commit to mdn/browser-compat-data that referenced this pull request Sep 4, 2021
@sideshowbarker
Un-deprecate FileSystemDirectoryReader (#12253)
26987ce 
FileSystemDirectoryReader should never have been marked at deprecated.
See mdn/content#8263 and see the spec at
https://wicg.github.io/entries-api/#api-directoryreader

Related MDN PR: mdn/content#8379
@teoli2003 teoli2003 mentioned this pull request May 9, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@teoli2003 teoli2003 teoli2003 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Issue with "FileSystemDirectoryReader.readEntries()": wrong Deprecated status?
2 participants
@sideshowbarker @teoli2003