Seed Fe Storage

https://github.com/xianghongai/seed-fe-storage
Admin
A data persistence library for browsers, built on localForage, supporting IndexedDB, WebSQL, and...
Tokens:1,139
Snippets:4
Trust Score:7.5
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install @seed-fe/storage

Source: https://github.com/xianghongai/seed-fe-storage/blob/main/README.md

Instructions for installing the @seed-fe/storage package using npm, yarn, or pnpm.

```bash
# npm
npm install @seed-fe/storage

# yarn
yarn add @seed-fe/storage

# pnpm (推荐)
pnpm add @seed-fe/storage
```

--------------------------------

### Basic Usage of @seed-fe/storage

Source: https://github.com/xianghongai/seed-fe-storage/blob/main/README.md

Demonstrates the fundamental operations of the storage instance, including setting, getting, removing items, retrieving all keys, and clearing the storage. All operations are asynchronous and require `async/await`.

```typescript
import storage from '@seed-fe/storage';

// 存储数据
await storage.setItem('user', { id: 1, name: 'John' });

// 获取数据
const user = await storage.getItem('user');
console.log(user); // { id: 1, name: 'John' }

// 删除数据
await storage.removeItem('user');

// 获取所有键名
const keys = await storage.keys();
console.log(keys); // ['key1', 'key2', ...]

// 清除所有数据
await storage.clear();
```

--------------------------------

### Create Independent Storage Instances

Source: https://github.com/xianghongai/seed-fe-storage/blob/main/README.md

Shows how to create separate, isolated storage instances using the `createStorage` function. This is useful for managing different types of data or for different parts of an application.

```typescript
import { createStorage } from '@seed-fe/storage';

// 创建独立的存储实例
const userStorage = createStorage('user');
const settingsStorage = createStorage('settings');

// 使用独立实例
await userStorage.setItem('profile', { /* ... */ });
await settingsStorage.setItem('theme', 'dark');
```

--------------------------------

### TypeScript Support with Type Safety

Source: https://github.com/xianghongai/seed-fe-storage/blob/main/README.md

Illustrates how to leverage TypeScript for type-safe storage operations by defining types for the data being stored and retrieved. This enhances code reliability and developer experience.

```typescript
type User = {
  id: number;
  name: string;
  email: string;
};

// 类型安全的存储操作
await storage.setItem<User>('currentUser', {
  id: 1,
  name: 'John',
  email: 'john@example.com'
});

const user = await storage.getItem<User>('currentUser');

if (user) {
  console.log(user.name); // TypeScript 类型提示
}
```
Tokens:
Raw