https://github.com/adriano-di-giovanni/cordova-plugin-shared-preferences

Shared preferences for Cordova. Save and retrieve persistent key-value pairs of any Javascript data type.
https://github.com/adriano-di-giovanni/cordova-plugin-shared-preferences

cordova cordova-android cordova-android-plugin cordova-ios cordova-ios-plugin cordova-plugin shared-preferences

Last synced: 2 months ago
JSON representation

Shared preferences for Cordova. Save and retrieve persistent key-value pairs of any Javascript data type.

• Host: GitHub
• URL: https://github.com/adriano-di-giovanni/cordova-plugin-shared-preferences
• Owner: adriano-di-giovanni
• License: mit
• Created: 2018-01-29T14:49:43.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-07-26T15:14:52.000Z (over 5 years ago)
• Last Synced: 2024-11-08T04:20:59.984Z (2 months ago)
• Topics: cordova, cordova-android, cordova-android-plugin, cordova-ios, cordova-ios-plugin, cordova-plugin, shared-preferences
• Language: JavaScript
• Size: 16.6 KB
• Stars: 9
• Watchers: 4
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.hbs
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shared preferences for Cordova

[![Build Status](https://travis-ci.org/adriano-di-giovanni/cordova-plugin-shared-preferences.svg?branch=master)](https://travis-ci.org/adriano-di-giovanni/cordova-plugin-shared-preferences)

This plugin provides the ability to save and retrieve persistent key-value pairs of any Javascript data type. You can use this plugin to save any data: arrays, booleans, numbers, strings and objects. This data will persist across user sessions.

This plugin uses [SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences.html) on Android and [NSUserDefaults](https://developer.apple.com/documentation/foundation/nsuserdefaults?language=objc) on iOS.

### Highlights

* save and retrieve key-value pairs of any Javascript data type using JSON serialization and parsing with `.put()` and `.get()`;

* also save and retrieve key-value pairs of booleans, numbers and strings mapping to native data types with `.putBoolean()`, `.getBoolean()`, `.putNumber()`, `.getNumber()`, `.putString()`, `.getString()`;

* fallback to user-defined default value if the key doesn't exist;

* manage multiple sets of preferences;

* well-tested cross-browser implementation.

Please, refer to [Installation](#installation), [Usage](#usage) and [API reference](#api_reference) sections for more information.

## Supported platforms

* Android

* iOS

## Installation 

```bash

npm install cordova-plugin-awesome-shared-preferences

```

## Usage 

Invoke `SharedPreferences.getInstance()` to retrieve the instance for the default set of preferences:

```javascript

var sharedPreferences = window.plugins.SharedPreferences.getInstance()

```

You can manage multiple sets of preferences. Invoke `SharePreferences.getInstance(name)` to retrieve an instance for a specific set:

```javascripts

var sharedPreferences = window.plugins.SharedPreferences.getInstance('settings')

```

Set a new preference using `.put()`:

```javascript

var key = 'fruits'

var value = ['Apple', 'Banana']

var successCallback = function() {

    console.log('OK')

}

var errorCallback = function(err) {

    console.error(err)

}

sharedPreferences.put(key, value, successCallback, errorCallback)

```

Retrieve a value from the preferences using `.get()`:

```javascript

var key = 'fruits'

var successCallback = function(value) {

    console.log(value)

}

var errorCallback = function(err) {

    console.log(err)

}

sharedPreferences.get(key, successCallback, errorCallback)

```

If the key doesn't exist, the `errorCallback` will be invoked. You can override this behavior providing a default value:

```javascript

var key = 'animals' // the key doesn't exist

var defaultValue = 'Dog'

var successCallback = function(value) {

    console.log(value) // Dog

}

var errorCallback = function(err) {

    console.error(err)

}

sharedPreferences.get(key, defaultValue, successCallback, errorCallback)

```

Delete a key-value pair from the preferences using `.del()`:

```javascript

var key = 'fruits'

var successCallback = function() {

    console.log('OK')

}

var errorCallback = function(err) {

    console.error(err)

}

sharedPreferences.del(key, successCallback, errorCallback)

```

## API reference 

{{#module name="SharedPreferences"}}

{{>body~}}

{{>member-index~}}

{{>separator~}}

{{>members~}}

{{/module}}

## License

This project is licensed under the MIT license.