2.0.0-beta1 • Published 2 years ago

@huds0n/shared-state-store-rn v2.0.0-beta1

Weekly downloads
121
License
MIT
Repository
-
Last release
2 years ago

Status GitHub Issues GitHub Pull Requests License


📝 Table of Contents

🧐 About

Add state persisting to React Native projects using the @huds0n/shared-state module.

✅ List of Features

  • Quick: Initialize a store in a single line.
  • Secure: Built in AES encryption.
  • Specific: Use include/exclude keys to specify which props to save.
  • Automatic: Have state save on background or after change.

🏁 Getting Started

Prerequisites

Requires huds0n/shared-state and @react-native-async-storage/async-storage.

Installing

npm i @huds0n/shared-state-store-rn

🧑‍💻 Usage

Persist a Shared State

import { SharedState } from "@huds0n/shared-state";

const ExampleState = new SharedState({
  username: null,
  password: null
  ...ect
});

ExampleState.initializeStorage(
  createStoreRN(storeOptions),
);

Returns a promise that resolve with true/false depending on success.See reference for storeOptions.

📖 Reference

Store Options

PropRequired/(Default)DescriptionType
encryptionKey-AES encryption stringStorage unencrypted if undefinedstring
excludeKeys-List of state props not to savearray of state keys
includeKeys-List of state props to saveAll other state props skippedOverrides excludeKeys proparray of state keys
replacer-Replacer function used in stringifing the save state(key: string, value: any) => any
reviver-Reviver function used in parse the save state(key: string, value: any) => any
saveOnBackgroundfalseSaves state automatically when app is backgroundedboolean
saveAutomaticallyfalseSaves state automatically whenever state changesboolean
storeNamename of storestring

✍️ Authors

See also the list of contributors who participated in this project.

🎉 Acknowledgements

  • Special thanks to my fiance, Arma, who has been so patient with all my extra-curricular work.
2.0.0-beta1

2 years ago

1.6.0-beta13

4 years ago

1.6.0-beta53

4 years ago

1.6.0-beta54

4 years ago

1.6.0-beta60

4 years ago

1.6.0-beta61

4 years ago

1.6.0-beta63

4 years ago

1.6.0-beta46

4 years ago

1.6.0-beta47

4 years ago

1.6.0-beta48

4 years ago

1.6.0-beta49

4 years ago

1.6.0-beta42

4 years ago

1.6.0-beta44

4 years ago

1.6.0-beta45

4 years ago

1.6.0-beta50

4 years ago

1.6.0-beta51

4 years ago

1.6.0-beta52

4 years ago

1.6.0-beta35

4 years ago

1.6.0-beta36

4 years ago

1.6.0-beta37

4 years ago

1.6.0-beta38

4 years ago

1.6.0-beta31

4 years ago

1.6.0-beta40

4 years ago

1.6.0-beta26

4 years ago

1.5.1-beta3

4 years ago

1.5.1-beta.1

4 years ago

1.5.1-beta.2

4 years ago

1.5.0-beta.21

4 years ago

1.5.0-beta.20

4 years ago

1.5.0-beta.16

4 years ago

1.5.0-beta.15

4 years ago

1.5.0-beta.14

4 years ago

1.5.0-beta.13

4 years ago

1.4.6

4 years ago

1.4.5

4 years ago

1.4.4

4 years ago

1.4.3

4 years ago

1.4.2

4 years ago

1.4.1

4 years ago

1.4.0

4 years ago

1.3.4-beta.4

5 years ago

1.3.4-beta.3

5 years ago

1.3.4-beta.2

5 years ago

1.3.4-beta.1

5 years ago

1.3.3-beta.5

5 years ago

1.3.3-beta.7

5 years ago

1.3.3-beta.6

5 years ago

1.3.3-beta.3

5 years ago

1.3.3-beta.4

5 years ago

1.3.3-beta.2

5 years ago

1.3.2-beta.8

5 years ago

1.3.2-beta.7

5 years ago

1.3.2-beta.6

5 years ago

1.3.2-beta.5

5 years ago

1.3.2-beta.4

5 years ago

1.3.2-beta.3

5 years ago

1.3.2-beta.1

5 years ago

1.3.1-beta.24

5 years ago

1.3.1-beta.23

5 years ago

1.3.1-beta.21

5 years ago

1.3.1-beta.22

5 years ago

1.3.1-beta.20

5 years ago

1.3.1-beta.16

5 years ago

1.3.1-beta.17

5 years ago

1.3.1-beta.15

5 years ago

1.3.1-beta.11

5 years ago

1.3.1-beta.9

5 years ago

1.3.1-beta.7

5 years ago

1.3.1-beta.6

5 years ago

1.3.0-beta.22

5 years ago

1.3.0-beta.21

5 years ago

1.3.0-beta.20

5 years ago

1.3.0-beta.19

5 years ago

1.3.0-beta.18

5 years ago