react-native-keychain - npm Package Compare versions

Comparing version 6.1.1 to 6.2.0

index.js

@@ -193,3 +193,3 @@ // @flow
   serviceOrOptions?: string | Options
-): Promise<false | SharedWebCredentials> {
+): Promise<false | UserCredentials> {
   const options = normalizeOptions(serviceOrOptions);
@@ -196,0 +196,0 @@ return RNKeychainManager.getGenericPasswordForOptions(options);

package.json

 {
   "name": "react-native-keychain",
-  "version": "6.1.1",
+  "version": "6.2.0",
   "description": "Keychain Access for React Native",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -459,2 +459,28 @@ <h1 align="center">react-native-keychain</h1>
 
+#### Configuring the Android-specific behavior
+
+Android implementation has behavioural specifics incurred by existing inconsistency between implementations by different vendors. E.g., some Samsung devices show very slow startup of crypto system. To alleviate this, a warm-up strategy is introduced in Android implementation of this library. 
+
+Using default constructor you get default behaviour, i.e. with the warming up on.
+```java
+    private List<ReactPackage> createPackageList() {
+      return Arrays.asList(
+        ...
+        new KeychainPackage(),  // warming up is ON
+        ...
+      )
+
+``` 
+Those who want finer control are required to use constructor with a builder which can be configured as they like:
+```java
+    private List<ReactPackage> createPackageList() {
+      return Arrays.asList(
+        ...
+        new KeychainPackage(
+                new KeychainModuleBuilder()
+                        .withoutWarmUp()),   // warming up is OFF
+        ...
+      )
+```
+
 ### iOS Notes
@@ -461,0 +487,0 @@

typings/react-native-keychain.d.ts

@@ -94,3 +94,3 @@ declare module 'react-native-keychain' {
     options?: Options
-  ): Promise<false | SharedWebCredentials>;
+  ): Promise<false | UserCredentials>;
 
@@ -111,3 +111,3 @@ function resetGenericPassword(options?: Options): Promise<boolean>;
     options?: Options
-  ): Promise<false | UserCredentials>;
+  ): Promise<false | SharedWebCredentials>;
 
@@ -114,0 +114,0 @@ function resetInternetCredentials(

No alert changes

Improved metrics

Total package byte prevSize

216243

increased by1.54%

Number of package files

36

increased by2.86%

Number of lines in readme file

560

increased by4.87%

No dependency changes