React Native Fast Secure Storage

https://reactnative.directory/package/react-native-fast-secure-storage
Admin
A React Native library for securely storing sensitive data using iOS KeyChain and Android Encrypted...
Tokens:2,533
Snippets:43
Trust Score:8.7
Update:8 months ago
Show doc for...
Tokens:
Raw
### Install react-native-fast-secure-storage using npm or yarn

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Instructions for installing the react-native-fast-secure-storage library using either npm or yarn package managers.

```bash
npm install react-native-fast-secure-storage
```

```bash
yarn add react-native-fast-secure-storage
```

--------------------------------

### Mock React Native Fast Secure Storage for Jest Testing

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Provides instructions on how to mock the 'react-native-fast-secure-storage' library for Jest testing. By adding the provided code to your Jest setup file, you can ensure that tests involving secure storage can run without actual native dependencies.

```javascript
jest.mock('react-native-fast-secure-storage', () => require("react-native-fast-secure-storage/jest"));
```

--------------------------------

### Synchronously retrieve an item using getItemSync

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Provides an example of synchronously retrieving an item from secure storage using its key. This method is useful when immediate access to the value is required without using async/await.

```javascript
import SecureStorage from 'react-native-fast-secure-storage';

const value = secureStorage.getItemSync('key1');
console.log(value); // Output: 'value1'

```

--------------------------------

### Retrieve all keys from secure storage

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Shows how to get an array containing all the keys currently stored in the secure storage. This is useful for iterating over stored data.

```javascript
import SecureStorage, { ACCESSIBLE } from "react-native-fast-secure-storage";
const testItems = [
    {
        key: "key1",
        value: "value1",
        accessibleValue: ACCESSIBLE.WHEN_UNLOCKED
    },
    {
        key: "key2",
        value: "value2",
        accessibleValue: ACCESSIBLE.WHEN_UNLOCKED
    },
];

await SecureStorage.setItems(testItems);

const keys = SecureStorage.getAllKeys();

console.log(keys); // output: ["ke1", "key2"]

```

--------------------------------

### Clear all items from secure storage

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Provides an example of how to remove all stored items from the secure storage. This action is irreversible.

```javascript
import SecureStorage from "react-native-fast-secure-storage";

await SecureStorage.clearStorage()

```

--------------------------------

### Retrieve all items from secure storage

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Demonstrates how to retrieve all stored items as an array of objects, where each object contains a key and its corresponding value. This allows access to all data at once.

```javascript
import SecureStorage, { ACCESSIBLE } from "react-native-fast-secure-storage";
const testItems = [
    {
        key: "key1",
        value: "value1",
        accessibleValue: ACCESSIBLE.WHEN_UNLOCKED
    },
    {
        key: "key2",
        value: "value2",
        accessibleValue: ACCESSIBLE.WHEN_UNLOCKED
    },
];

await SecureStorage.setItems(testItems);

const secureStorageItems = SecureStorage.getAllKeys();

console.log(secureStorageItems); // output: [{ key: "key1", value: "value1" }, {key: "key2", value: "value2" }]

```

--------------------------------

### Store multiple items securely using setItems

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Demonstrates how to store an array of key-value pairs simultaneously. Each item in the array can optionally specify its accessibility level.

```javascript
import SecureStorage, { ACCESSIBLE } from "react-native-fast-secure-storage";
const testItems = [
    {
        key: "key1",
        value: "value1",
        accessibleValue: ACCESSIBLE.WHEN_UNLOCKED
    },
    {
        key: "key2",
        value: "value2",
        accessibleValue: ACCESSIBLE.WHEN_UNLOCKED
    },
];

await SecureStorage.setItems(testItems);

```

--------------------------------

### Store an item securely using setItem

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Demonstrates how to store a key-value pair securely in the storage. It allows specifying an accessibility level for the stored item. The default accessibility is WHEN_UNLOCKED.

```javascript
import SecureStorage, { ACCESSIBLE } from "react-native-fast-secure-storage";

const result = await SecureStorage.setItem("key1", "value1", ACCESSIBLE.WHEN_UNLOCKED)

```

--------------------------------

### Retrieve an item securely using getItem

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Shows how to retrieve a stored item from secure storage using its key. This method returns the value associated with the key. It throws an error if the key does not exist or the value is empty.

```javascript
import SecureStorage from "react-native-fast-secure-storage";

const result = await SecureStorage.getItem("key1")

console.log(result); // output: value1

```

--------------------------------

### Synchronously store an item using setItemSync

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Demonstrates how to store a key-value pair synchronously in secure storage. This method returns a boolean indicating success or failure.

```javascript
const setResult = secureStorage.setItemSync('key1', 'value1');
console.log(setResult); // Output: true

```

--------------------------------

### Check Item Existence Synchronously in React Native Secure Storage

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Demonstrates how to synchronously check if an item exists in the secure storage using the `hasItemSync` method. This function takes the item's key as input and returns a boolean indicating its presence. It's useful for verifying data before attempting to retrieve or modify it.

```javascript
const setResult = secureStorage.setItemSync('key1', 'value1');
const exists = secureStorage.hasItemSync('key1');
console.log(exists); // Output: true
```

--------------------------------

### Remove an item from secure storage using removeItem

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Shows how to delete a specific item from the secure storage by providing its key. After deletion, attempting to retrieve the item will result in an error.

```javascript
import SecureStorage from "react-native-fast-secure-storage";

await SecureStorage.setItem("key1", "value1");

await SecureStorage.deleteItem("key1");

try { 
  await SecureStorage.getItem("key1")
} cath(e) {
  console.log(e) // output: value does not exist
}

```

--------------------------------

### Check if an item exists in secure storage using hasItem

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Demonstrates how to check for the existence of an item in the secure storage by its key. It returns a boolean value: true if the item exists, false otherwise.

```javascript
import SecureStorage from "react-native-fast-secure-storage";

await SecureStorage.setItem("key1", "value1");

const result = await SecureStorage.hasItem("key1");

console.log(result) // output: true

```

--------------------------------

### Remove Item Synchronously from React Native Secure Storage

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Illustrates how to synchronously remove an item from secure storage using the `removeItemSync` method. This function requires the item's key as an argument. It's a straightforward way to clear specific data from the storage.

```javascript
const setResult = secureStorage.setItemSync('key1', 'value1');
const removeResult = secureStorage.removeItemSync('key1');
```

--------------------------------

### hasItemSync

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Checks if an item exists in the secure storage synchronously. This method is useful for verifying the presence of a key before attempting to retrieve or modify its associated value.

```APIDOC
## hasItemSync

### Description
Checks if an item exists in the secure storage synchronously.

### Method
GET (or equivalent synchronous operation)

### Endpoint
N/A (Synchronous method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
const exists = secureStorage.hasItemSync('key1');
console.log(exists);
```

### Response
#### Success Response (boolean)
- **exists** (boolean) - True if the item exists, false otherwise.

#### Response Example
```json
true
```
```

--------------------------------

### removeItemSync

Source: https://reactnative.directory/package/react-native-fast-secure-storage/index

Removes an item from the secure storage synchronously. This operation deletes the key-value pair associated with the provided key.

```APIDOC
## removeItemSync

### Description
Removes an item from the secure storage synchronously.

### Method
DELETE (or equivalent synchronous operation)

### Endpoint
N/A (Synchronous method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
const removeResult = secureStorage.removeItemSync('key1');
```

### Response
#### Success Response (boolean)
- **removed** (boolean) - True if the item was successfully removed, false otherwise.

#### Response Example
```json
true
```
```
Tokens:
Raw