@nhost/hasura-auth-js - npm Package Compare versions

Comparing version 2.5.3 to 2.5.4

dist/types/client.d.ts

@@ -95,11 +95,61 @@ import { NhostSession, Provider } from './hasura-auth';
      * Recommended values:
+     *
      * - `'web'` and `'cookies'`: no value is required
-     * - `'react-native'`: `import Storage from @react-native-async-storage/async-storage`
-     * - `'cookies'`: `localStorage`
+     * - `'react-native'`: use [@react-native-async-storage/async-storage](https://www.npmjs.com/package/@react-native-async-storage/async-storage)
+     *   ```ts
+     *   import { NhostClient } from '@nhost/nhost-js'
+     *   import AsyncStorage from '@react-native-async-storage/async-storage';
+     *   const nhost = new NhostClient({
+     *     ...
+     *     clientStorageType: 'react-native',
+     *     clientStorage: AsyncStorage
+     *   })
+     *   ```
      * - `'custom'`: an object that defines the following methods:
-     *     - `setItem` or `setItemAsync`
-     *     - `getItem` or `getItemAsync`
-     *     - `removeItem`
-     * - `'capacitor'`: `import { Storage } from @capacitor/storage`
-     * - `'expo-secure-store'`: `import * as SecureStore from 'expo-secure-store'`
+     *   - `setItem` or `setItemAsync`
+     *   - `getItem` or `getItemAsync`
+     *   - `removeItem`
+     * - `'capacitor'`:
+     *
+     *   - capacitor version **< 4** : use [@capacitor/storage](https://www.npmjs.com/package/@capacitor/storage)
+     *
+     *   ```ts
+     *   import { NhostClient } from '@nhost/nhost-js'
+     *   import { Storage } from '@capacitor/storage'
+     *   const nhost = new NhostClient({
+     *     ...
+     *     clientStorageType: 'capacitor',
+     *     clientStorage: Storage
+     *   })
+     *   ```
+     *
+     *   - capacitor version **>= 4** : use [@capacitor/preferences](https://www.npmjs.com/package/@capacitor/preferences)
+     *
+     *   ```ts
+     *   import { NhostClient  } from '@nhost/nhost-js';
+     *   import { Preferences } from '@capacitor/preferences';
+     *   const nhost = new NhostClient({
+     *     ...
+     *     clientStorageType: 'custom',
+     *     clientStorage: {
+     *       setItemAsync: async (key, value) => Preferences.set({ key, value }),
+     *       getItemAsync: async (key) => {
+     *         const { value } = await Preferences.get({ key });
+     *         return value;
+     *       },
+     *       removeItem: (key) => Preferences.remove({ key })
+     *     },
+     *   });
+     *   ```
+     *
+     * - `'expo-secure-store'`: use [expo-secure-store](https://www.npmjs.com/package/expo-secure-store)
+     *   ```ts
+     *     import { NhostClient } from '@nhost/nhost-js'
+     *     import * as SecureStore from 'expo-secure-store';
+     *     const nhost = new NhostClient({
+     *       ...
+     *       clientStorageType: 'expo-secure-store',
+     *       clientStorage: SecureStore
+     *     })
+     *   ```
      */
@@ -106,0 +156,0 @@ clientStorage?: ClientStorage;

package.json

 {
   "name": "@nhost/hasura-auth-js",
-  "version": "2.5.3",
+  "version": "2.5.4",
   "description": "Hasura-auth client",
@@ -5,0 +5,0 @@ "license": "MIT",

No alert changes

Improved metrics

Total package byte prevSize

1447952

0.13%

Lines of code

8023

0.63%

No dependency changes