npmpackage.info

Gathering detailed insights and metrics for @effector-storage/react-native-encrypted-storage

@effector-storage/react-native-encrypted-storage - 1.1.0 | npmpackage.info

@effector-storage/react-native-encrypted-storage

Extra adapters for effector-storage package

1.1.0

MIT

TypeScript

14.97 kB

Installations

npm install @effector-storage/react-native-encrypted-storage

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

20.10.0

NPM Version

10.2.3 Pull Requests

Open

10

Total

134

Closed

110

Merged

14

Issues

Open

4

Total

5

Closed

1

Releases

@effector-storage/react-native-async-storage@2.0.0

Updated on Sep 08, 2024

@effector-storage/keyv@2.0.0

Updated on Sep 08, 2024

@effector-storage/idb-keyval@2.0.0

Updated on Sep 08, 2024

@effector-storage/keyv@1.1.0

Updated on Nov 29, 2023

@effector-storage/idb-keyval@1.1.0

Updated on Nov 29, 2023

@effector-storage/react-native-encrypted-storage@1.1.0

Updated on Nov 29, 2023

View All 14 releases

Languages

TypeScript

JavaScript

TypeScript (75.06%)

JavaScript (24.94%)

Developer

yumauri

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

6 Stars

92 Commits

2 Watchers

11 Branches

2 Contributors

Updated on Feb 20, 2025

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

1.1.0

Package Id

@effector-storage/react-native-encrypted-storage@1.1.0

Unpacked Size

14.97 kB

Size

4.03 kB

File Count

NPM Version

10.2.3

Node Version

20.10.0

Published on

Nov 29, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

effector-storage react-native-encrypted-storage

Peer Dependencies

effector

React Native EncryptedStorage adapter

Adapter to persist store using React Native EncryptedStorage.

Preconditions

@effector-storage/react-native-encrypted-storage has dependency on react-native-encrypted-storage, so it will auto install it.

But depending on your platform and React Native version, you might want to install EncryptedStorage manually, because it might require linking.

So, install EncryptedStorage, following documentation for your platform.

Install

Depending on your package manager

1# using `pnpm` ↓
2$ pnpm add effector-storage @effector-storage/react-native-encrypted-storage
3
4# using `yarn` ↓
5$ yarn add effector-storage @effector-storage/react-native-encrypted-storage
6
7# using `npm` ↓
8$ npm install --save effector-storage @effector-storage/react-native-encrypted-storage

Usage

Import persist function from '@effector-storage/react-native-encrypted-storage' module, and it will just work:

1import { persist } from '@effector-storage/react-native-encrypted-storage'
2
3// persist store `$counter` with key 'counter'
4persist({ store: $counter, key: 'counter' })
5
6// if your storage has a name, you can omit `key` field
7persist({ store: $counter })

⚠️ Note, that EncryptedStorage is asynchronous.

Two (or more) different stores, persisted with the same key, will be synchronized (synchronously!), even if not connected with each other directly — each store will receive updates from another one.

Formulae

1import { persist } from '@effector-storage/react-native-encrypted-storage'

persist({ store, ...options }): Subscription
persist({ source, target, ...options }): Subscription

Options

... all the common options from effector-storage's persist function.
serialize? ((value: any) => string): Custom serialize function. Default = JSON.stringify.
deserialize? ((value: string) => any): Custom deserialize function. Default = JSON.parse.

Adapter

1import { adapter } from '@effector-storage/react-native-encrypted-storage'

adapter(options?): StorageAdapter

Options

serialize? ((value: any) => string): Custom serialize function. Default = JSON.stringify.
deserialize? ((value: string) => any): Custom deserialize function. Default = JSON.parse.

FAQ

How do I use custom serialization / deserialization?

Options serialize and deserialize are got you covered. But make sure, that serialization is stable, meaning, that deserialize(serialize(object)) is equal to object (or serialize(deserialize(serialize(object))) === serialize(object)):

1import { persist } from '@effector-storage/react-native-encrypted-storage'
2
3const $date = createStore(new Date(), { name: 'date' })
4
5persist({
6  store: $date,
7  serialize: (date) => String(date.getTime()),
8  deserialize: (timestamp) => new Date(Number(timestamp)),
9})

No vulnerabilities found.

No security vulnerabilities found.