0.0.2 • Published 2 years ago

@drpiou/expo-secure-storage v0.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

@drpiou/expo-secure-store

GitHub GitHub package.json version Jest tests

The @drpiou/expo-secure-store package wraps the expo-secure-store package.

  • type SecureStore.
  • written in TypeScript.

Compatibility

  • Expo (43+)

Installation

yarn add @drpiou/expo-secure-store

Peer Dependencies

Expo project:

expo install expo-secure-store

Example

import { SecureStore } from '@drpiou/expo-secure-store';

type StorageItemValueMap = {
  credentials: {
    access_token: string;
    refresh_token: string;
  };
};

const storage = new SecureStore<StorageItemValueMap>();

Documentation

class SecureStore<S extends Record<string, unknown>> {
  getItem: <K extends keyof S, D extends S[K] | undefined>(
    key: K,
    defaultValue?: D,
    autoSet?: boolean,
  ) => Promise<D extends undefined ? S[K] | undefined : S[K]>;

  setItem: <K extends keyof S>(key: K, value: S[K]) => Promise<void>;

  hasItem: (key: keyof S) => Promise<boolean>;

  removeItem: (key: keyof S) => Promise<void>;
}