devs
/
emoji-picker-element
mirror of https://github.com/nolanlawson/emoji-picker-element.git
4
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: add documentation

This commit is contained in:
Nolan Lawson 2020-06-13 18:23:50 -07:00
parent 00d35c6b3e
commit 3904340e6c
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -276,6 +276,8 @@ Name | Type | Default | Description |
Closes the underlying IndexedDB connection. The Database is not usable after that (or any other Databases
with the same locale).
Note that as soon as any other non-close/delete method is called, the database will automatically reopen.
**Returns:** *Promise‹void›*
___
@ -287,6 +289,8 @@ ___
Deletes the underlying IndexedDB database. The Database is not usable after that (or any other Databases
with the same locale).
Note that as soon as any other non-close/delete method is called, the database will be recreated.
**Returns:** *Promise‹void›*
___

4
src/types/database.ts
View File

@ -109,6 +109,8 @@ export default class Database {
* Closes the underlying IndexedDB connection. The Database is not usable after that (or any other Databases
* with the same locale).
*
* Note that as soon as any other non-close/delete method is called, the database will automatically reopen.
*
*/
close(): Promise<void> {
return Promise.resolve()
@ -118,6 +120,8 @@ export default class Database {
* Deletes the underlying IndexedDB database. The Database is not usable after that (or any other Databases
* with the same locale).
*
* Note that as soon as any other non-close/delete method is called, the database will be recreated.
*
*/
delete(): Promise<void> {
return Promise.resolve()