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.

Sign up for GitHub

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

docs: Fix return type for CapacitorKV.get in documentation #42

Merged
merged 2 commits into from
Aug 28, 2023
Merged

docs: Fix return type for CapacitorKV.get in documentation #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
388e3eb
Fix type for CapacitorKV.get in documentation
MrNNP Aug 22, 2023
2c3c9f4
build docs
theproducer Aug 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ A simple string key / value store backed by UserDefaults on iOS and Shared Prefe
| Prop | Type | Description | Since |
| ------------ | ---------------------------------------------------- | -------------------------------------- | ----- |
| **`set`** | <code>(key: string, value: string) =&gt; void</code> | Set a string value with the given key. | 1.0.0 |
| **`get`** | <code>(key: string) =&gt; string</code> | Get a string value for the given key. | 1.0.0 |
| **`get`** | <code>(key: string) =&gt; { value: string; }</code> | Get a string value for the given key. | 1.0.0 |
| **`remove`** | <code>(key: string) =&gt; void</code> | Remove a value with the given key. | 1.0.0 |


Expand Down
2 changes: 1 addition & 1 deletion packages/capacitor-plugin/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ A simple string key / value store backed by UserDefaults on iOS and Shared Prefe
| Prop | Type | Description | Since |
| ------------ | ---------------------------------------------------- | -------------------------------------- | ----- |
| **`set`** | <code>(key: string, value: string) =&gt; void</code> | Set a string value with the given key. | 1.0.0 |
| **`get`** | <code>(key: string) =&gt; string</code> | Get a string value for the given key. | 1.0.0 |
| **`get`** | <code>(key: string) =&gt; { value: string; }</code> | Get a string value for the given key. | 1.0.0 |
| **`remove`** | <code>(key: string) =&gt; void</code> | Remove a value with the given key. | 1.0.0 |


Expand Down
2 changes: 1 addition & 1 deletion packages/capacitor-plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ A simple string key / value store backed by UserDefaults on iOS and Shared Prefe
| Prop | Type | Description | Since |
| ------------ | ---------------------------------------------------- | -------------------------------------- | ----- |
| **`set`** | <code>(key: string, value: string) =&gt; void</code> | Set a string value with the given key. | 1.0.0 |
| **`get`** | <code>(key: string) =&gt; string</code> | Get a string value for the given key. | 1.0.0 |
| **`get`** | <code>(key: string) =&gt; { value: string; }</code> | Get a string value for the given key. | 1.0.0 |
| **`remove`** | <code>(key: string) =&gt; void</code> | Remove a value with the given key. | 1.0.0 |


Expand Down
2 changes: 1 addition & 1 deletion packages/capacitor-plugin/src/apis.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ export interface CapacitorKV {
* @returns
* @since 1.0.0
*/
get: (key: string) => string;
get: (key: string) => { value: string };
/**
* Remove a value with the given key.
* @param key
Expand Down
Loading