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

browsingData.removeCache: removalOptions is not optional #36812

Merged
merged 2 commits into from
Nov 27, 2024
Merged

Conversation

atjn
Copy link
Contributor

@atjn atjn commented Nov 15, 2024

Description

The current text says you can omit the removalOptions object. This is not the case, both Firefox and Chrome will throw an error if you do not pass an empty object to the function. I have changed the text to make this clear.

Motivation

It is false information that lead me to write failing code.

Additional details

I unfortunately cannot find any documentation on these APIs, but I have manually tested that this is the case in Firefox 132 and Chrome 130.

The example in this text also passes an empty object.

Related issues and pull requests

Slightly related: #27629

@atjn atjn requested a review from a team as a code owner November 15, 2024 16:43
@atjn atjn requested review from jpmedley and removed request for a team November 15, 2024 16:43
@github-actions github-actions bot added Content:WebExt WebExtensions docs size/s [PR only] 6-50 LoC changed labels Nov 15, 2024
Copy link
Contributor

github-actions bot commented Nov 27, 2024

Preview URLs

(comment last updated: 2024-11-27 22:32:09)

@rebloor rebloor merged commit 73eeba4 into mdn:main Nov 27, 2024
8 checks passed
@rebloor
Copy link
Contributor

rebloor commented Nov 27, 2024

@atjn many thanks for spotting that one and making the appropriate changes.

@atjn atjn deleted the patch-1 branch November 28, 2024 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebExt WebExtensions docs size/s [PR only] 6-50 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants