Skip to content

Commit 9358f76

Browse files
authored
Merge pull request #52 from seanpdoyle/document-options
Add function option documentation to `README.md`
2 parents e0984cd + c2538cf commit 9358f76

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,27 @@ window.addEventListener('pagehide', function() {
4646
})
4747
```
4848

49+
#### `restoreResumableFields(id: string, options)`
50+
51+
The `restoreResumableFields(id: string, options)` function supports optional configurations:
52+
53+
* `storage:` - [`Storage`][] instance (defaults to [`window.sessionStorage`][])
54+
* `keyPrefix:` - `string` prepended onto the storage key (defaults to `"session-resume"`)
55+
56+
[`Storage`]: https://developer.mozilla.org/en-US/docs/Web/API/Storage
57+
[`window.sessionStorage`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage
58+
59+
#### `persistResumableFields(id: string, options)`
60+
61+
The `persistResumableFields(id: string, options)` function supports optional configurations:
62+
63+
* `storage:` - [`Storage`][] instance (defaults to [`window.sessionStorage`][])
64+
* `selector:` - `string` used to query field elements (defaults to `".js-session-resumable"`)
65+
* `keyPrefix:` - `string` prepended onto the storage key (defaults to `"session-resume"`)
66+
67+
[`Storage`]: https://developer.mozilla.org/en-US/docs/Web/API/Storage
68+
[`window.sessionStorage`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage
69+
4970
## Development
5071

5172
```

0 commit comments

Comments
 (0)