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

Jump to bottom

Clarify docs for IndexedDB add returns a Future that has the key #11401

Closed
sethladd opened this issue Jun 20, 2013 · 10 comments
Closed

Clarify docs for IndexedDB add returns a Future that has the key #11401

sethladd opened this issue Jun 20, 2013 · 10 comments
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. docs-api library-indexeddb type-documentation A request to add or improve documentation

Comments

@sethladd
Copy link
Contributor

I saw in the tests this little gem:

   return transaction.objectStore(storeName).add(value).then((addedKey) {
      key = addedKey;
    }).then(() {
      return transaction.completed;
    }).then(() {

From https://code.google.com/p/dart/source/browse/trunk/dart/tests/html/indexeddb_5_test.dart

However, the docs for add() don't seem to hint that you can just get the key.

http://api.dartlang.org/docs/releases/latest/dart_indexed_db/ObjectStore.html#add

Can we update both the class level docs with an example or two, and the method docs to indicate what the Future actually completes with? That would be really helpful. Thanks!
@efortuna
Copy link
Contributor

Added this to the Later milestone.

@sethladd
Copy link
Contributor Author

Sending over to Mary, who knows how to update API docs and has worked with IndexedDB

Set owner to mcam...@google.com.
Removed this from the Later milestone.
Added this to the M7 milestone.
Removed Type-Enhancement, Priority-Unassigned, Area-HTML labels.
Added Type-Task, Priority-Medium, Area-Documentation, Docs-API labels.

@sethladd
Copy link
Contributor Author

sethladd commented Dec 4, 2013

Set owner to @sethladd.
Removed this from the M7 milestone.
Added this to the 1.1 milestone.

@kwalrath
Copy link
Contributor

Added Library-IndexedDB label.

@kevmoo
Copy link
Member

kevmoo commented May 14, 2014

Removed Type-Task, Area-Documentation, Docs-API labels.
Added Type-Documentation, Area-Library labels.

@kasperl
Copy link

kasperl commented Jun 4, 2014

Removed this from the 1.1 milestone.
Added this to the 1.6 milestone.

@kasperl
Copy link

kasperl commented Jul 10, 2014

Removed this from the 1.6 milestone.
Added Oldschool-Milestone-1.6 label.

@sethladd
Copy link
Contributor Author

Removed the owner.
Added Docs-API label.

@kasperl
Copy link

kasperl commented Aug 4, 2014

Removed Oldschool-Milestone-1.6 label.

@sethladd sethladd added type-documentation A request to add or improve documentation Priority-Medium area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-indexeddb docs-api labels Aug 4, 2014
@sethladd
Copy link
Contributor Author

sethladd commented Jun 4, 2015

Not planned. I'm also unclear how to update docs for dart:html, as I think they are generated?

@sethladd sethladd closed this as completed Jun 4, 2015
@kevmoo kevmoo removed the triaged label Mar 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. docs-api library-indexeddb type-documentation A request to add or improve documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@sethladd @kevmoo @efortuna @kasperl @kwalrath