W3cubDocs

/React Native

Settings

Settings serves as a wrapper for NSUserDefaults, a persistent key-value store available only on iOS.

Reference

Methods

clearWatch()

static clearWatch(watchId: number)

watchId is the number returned by watchKeys() when the subscription was originally configured.

get()

static get(key: string): mixed

Get the current value for a given key in NSUserDefaults.

set()

static set(settings: object)

Set one or more values in NSUserDefaults.

watchKeys()

static watchKeys(keys: string | array<string>, callback: function): number

Subscribe to be notified when the value for any of the keys specified by the keys parameter has been changed in NSUserDefaults. Returns a watchId number that may be used with clearWatch() to unsubscribe.

Note: watchKeys() by design ignores internal set() calls and fires callback only on changes preformed outside of React Native code.

© 2022 Facebook Inc.
Licensed under the Creative Commons Attribution 4.0 International Public License.
https://reactnative.dev/docs/settings