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

Note re exception from storage.managed.get #36586

Merged

Conversation

rebloor
Copy link
Contributor

@rebloor rebloor commented Oct 31, 2024

Description

Adds a note about the exception from storage.managed.get when the manage storage manifest isn't present.

Motivation

Documents a known issue with Firefox

Additional details

Originally noted as a documentation need in feedback on mdn/webextensions-examples#554

@rebloor rebloor added the Content:WebExt WebExtensions docs label Oct 31, 2024
@rebloor rebloor requested review from dotproto and Rob--W October 31, 2024 01:55
@rebloor rebloor self-assigned this Oct 31, 2024
@rebloor rebloor requested a review from a team as a code owner October 31, 2024 01:55
@github-actions github-actions bot added the size/s [PR only] 6-50 LoC changed label Oct 31, 2024
Copy link
Contributor

github-actions bot commented Oct 31, 2024

Preview URLs

External URLs (4)

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/managed
Title: storage.managed


URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/get
Title: StorageArea.get()

(comment last updated: 2024-11-01 02:47:42)

@@ -28,22 +28,14 @@ Where `<storageType>` is one of the storage types — {{WebExtAPIRef("storage.sy

### Return value

A [`Promise`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that resolves to a `results` object, containing every object in `keys` that was found in the storage area. If `keys` is an object, keys that are not found in the storage area will have their values given by the `keys` object.
A [`Promise`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that resolves to a `results` object, containing every object in `keys` found in the storage area. If `keys` is an object, keys that are not found in the storage area have their values given by the `keys` object.
Copy link
Collaborator

Choose a reason for hiding this comment

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

containing every object in keys found in the storage area.

The wording here seems a little off. The value associated with a given may be a primitive value rather than an object. Also, the structure of this sentence seems a little harder to parse than necessary. What do you think about this?

containing a key-value pair for every matching key found in the storage area.

rebloor and others added 2 commits November 1, 2024 15:09
Co-authored-by: Simeon Vincent <svincent@gmail.com>
@rebloor rebloor requested a review from dotproto November 1, 2024 02:46
Copy link
Collaborator

@dotproto dotproto left a comment

Choose a reason for hiding this comment

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

LGTM!

@rebloor rebloor merged commit 267c7ef into mdn:main Nov 14, 2024
8 checks passed
@rebloor rebloor deleted the storage.managed.get-without-storage.managed_schema branch November 14, 2024 01:19
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