Upgrade the feature

Author: dean

.babelrc

@@ -0,0 +1,10 @@
+{
+  "presets": [
+    ["@babel/env", { "targets": { "node": "current" } }],
+    "@babel/typescript"
+  ],
+  "plugins": [
+    ["@babel/plugin-proposal-decorators", { "legacy": true }],
+    ["@babel/proposal-class-properties", { "loose": true }]
+  ]
+}

.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: [
+    '@nuxtjs/eslint-config-typescript',
+    'prettier',
+    'prettier/standard',
+    'plugin:prettier/recommended',
+  ],
+  plugins: ['prettier'],
+  rules: {},
+}

.gitignore

@@ -0,0 +1,2 @@
+coverage
+dist

.prettierrc

@@ -0,0 +1,14 @@
+{
+  "semi": true,
+  "arrowParens": "always",
+  "singleQuote": true,
+  "htmlWhitespaceSensitivity": "ignore",
+  "overrides": [
+    {
+      "files": "*.js",
+      "options": {
+        "semi": false
+      }
+    }
+  ]
+}

__test__/helper.ts

@@ -0,0 +1,51 @@
+import { DriverInterface } from '../src';
+
+export enum StorageName {
+  user = 'user',
+  no = 'no',
+  enable = 'enable',
+  data = 'data',
+}
+export const defaults = {
+  [StorageName.user]: 'guest',
+  [StorageName.no]: -1,
+  [StorageName.enable]: false,
+  [StorageName.data]: {},
+};
+export const defLen = 4;
+
+let saved: { [name: string]: any } = {};
+export function restoreSaved() {
+  saved = {
+    [StorageName.user]: 'user001',
+    [StorageName.no]: 123,
+    [StorageName.data]: { name: 'John', age: 12 },
+  };
+}
+export function clearSaved() {
+  saved = {};
+}
+export function getSaved(name: string) {
+  return saved[name];
+}
+export function setSaved(name: string, value: any) {
+  saved[name] = value;
+}
+
+export class AsyncDriver implements DriverInterface {
+  async getItem(name: string) {
+    await delay(100);
+    return getSaved(name) ? getSaved(name) : null;
+  }
+
+  async setItem(name: string, value: string) {
+    await delay(100);
+    setSaved(name, value);
+  }
+}
+
+function delay(t: number) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, t);
+  });
+}

__test__/strict-async-storage.spec.ts

@@ -0,0 +1,127 @@
+import { StrictAsyncStorage, DriverInterface } from '../src';
+import {
+  getSaved,
+  setSaved,
+  defaults,
+  AsyncDriver,
+  StorageName,
+  restoreSaved,
+  defLen,
+} from './helper';
+
+describe('strict-async-storage', () => {
+  jest
+    .spyOn(Object.getPrototypeOf(localStorage) as Storage, 'getItem')
+    .mockImplementation((name: string) => {
+      return getSaved(name) ? getSaved(name) : null;
+    });
+  jest
+    .spyOn(Object.getPrototypeOf(localStorage) as Storage, 'setItem')
+    .mockImplementation((name: string, value: string) => {
+      setSaved(name, value);
+    });
+  oneSetTest('default sync', new StrictAsyncStorage(defaults));
+
+  oneSetTest(
+    'cunstom async',
+    new StrictAsyncStorage(defaults, {
+      map: new Map(),
+      driver: () => new AsyncDriver(),
+    }),
+    true
+  );
+});
+
+function oneSetTest<TDriver extends DriverInterface = Storage>(
+  testName: string | number | Function | jest.FunctionLike,
+  strictAsyncStorage: StrictAsyncStorage<typeof defaults, StorageName, TDriver>,
+  handleDispose = false
+) {
+  describe(testName, () => {
+    restoreSaved();
+    beforeAll(async () => {
+      await strictAsyncStorage.init();
+    });
+
+    it('test length', async () => {
+      expect(await strictAsyncStorage.length).toBe(defLen);
+    });
+
+    it('test getItem', () => {
+      expect(strictAsyncStorage.getItem(StorageName.user)).toBe(
+        getSaved(StorageName.user)
+      );
+      expect(strictAsyncStorage.getItem(StorageName.no)).toBe(
+        getSaved(StorageName.no)
+      );
+      expect(strictAsyncStorage.getItem(StorageName.enable)).toBe(
+        defaults[StorageName.enable]
+      );
+      expect(strictAsyncStorage.getItem(StorageName.data)).toEqual(
+        getSaved(StorageName.data)
+      );
+
+      expect(() => strictAsyncStorage.getItem('other' as any)).toThrowError(
+        RangeError
+      );
+    });
+
+    it('test setItem', async () => {
+      const user = 'test001';
+      await strictAsyncStorage.setItem(StorageName.user, user);
+      expect(strictAsyncStorage.getItem(StorageName.user)).toBe(user);
+
+      await strictAsyncStorage.setItem(StorageName.user, undefined as any);
+      expect(strictAsyncStorage.getItem(StorageName.user)).toBeUndefined();
+      await strictAsyncStorage.setItem(StorageName.user, null as any);
+      expect(strictAsyncStorage.getItem(StorageName.user)).toBe(
+        defaults[StorageName.user]
+      );
+
+      await expect(
+        strictAsyncStorage.setItem('other' as any, null as any)
+      ).rejects.toThrowError(RangeError);
+    });
+
+    it('test resetItem', async () => {
+      expect(await strictAsyncStorage.resetItem(StorageName.user)).toBe(
+        defaults[StorageName.user]
+      );
+      expect(strictAsyncStorage.getItem(StorageName.user)).toBe(
+        defaults[StorageName.user]
+      );
+
+      await expect(
+        strictAsyncStorage.resetItem('other' as any)
+      ).rejects.toThrowError(RangeError);
+    });
+
+    it('test resetAll', async () => {
+      await strictAsyncStorage.resetAll();
+
+      expect(strictAsyncStorage.getItem(StorageName.user)).toBe(
+        defaults[StorageName.user]
+      );
+      expect(strictAsyncStorage.getItem(StorageName.no)).toBe(
+        defaults[StorageName.no]
+      );
+      expect(strictAsyncStorage.getItem(StorageName.enable)).toBe(
+        defaults[StorageName.enable]
+      );
+      expect(strictAsyncStorage.getItem(StorageName.data)).toEqual(
+        defaults[StorageName.data]
+      );
+    });
+
+    it('test dispose', () => {
+      if (handleDispose) {
+        const handler = jest.fn();
+        strictAsyncStorage.dispose(handler);
+        expect(handler).toBeCalled();
+      } else {
+        strictAsyncStorage.dispose();
+        expect(strictAsyncStorage.length).toBe(0);
+      }
+    });
+  });
+}

jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  preset: 'ts-jest',
+  rootDir: '.',
+  moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+    '^.+\\.jsx?$': 'babel-jest',
+  },
+  collectCoverage: true,
+  collectCoverageFrom: ['<rootDir>/src/**/*.ts'],
+}