feat: updateAPI to use options obj for everything

BREAKING CHANGE: Not backwards compatible with previous API

Author: mekwall

README.md

@@ -19,10 +19,12 @@ import { when } from 'mobx';
 import { createAsyncStore } from 'mst-async-store';
 
 // Generate store model
-const MyAsyncStore = createAsyncStore(
-  'MyAsyncStore', // Name of store
-  MyModel, // Your MST model representing one item
-  (self) => (
+const MyAsyncStore = createAsyncStore({
+  name: 'MyAsyncStore',
+  itemModel: MyModel,
+  ttl: 10000,
+  failstateTtl: 5000
+  fetchActions: (self) => (
     {
       // Logic to fetch one item
       async fetchOne(id: string) {
@@ -39,11 +41,9 @@ const MyAsyncStore = createAsyncStore(
         const data = await axios.get(`/all`);
         return data.response.map((d) => MyModel.create(d));
       },
-    },
-    // Store options
-    { ttl: 10000, failstateTtl: 5000 }
+    }
   )
-);
+});
 
 // Instantiate store
 const myAsyncStore = MyAsyncStore.create();

src/__tests__/createAsyncStore.spec.ts

@@ -6,23 +6,33 @@ const DummyModel = types.model('DummyModel', { id: types.identifier });
 
 describe('createAsyncStore', () => {
   it('should create AsyncStore model', () => {
-    const AsyncStore = createAsyncStore('AsyncStore', DummyModel);
+    const AsyncStore = createAsyncStore({
+      name: 'AsyncStore',
+      itemModel: DummyModel,
+    });
     expect(AsyncStore.name).toBe('AsyncStore');
   });
 
   it('should create asyncStore instance', () => {
-    const AsyncStore = createAsyncStore('AsyncStore', DummyModel);
+    const AsyncStore = createAsyncStore({
+      name: 'AsyncStore',
+      itemModel: DummyModel,
+    });
     const asyncStore = AsyncStore.create();
     expect(asyncStore.isReady).toBe(false);
   });
 
   it('should fetch one item', async () => {
     const dummyItem = DummyModel.create({ id: 'foo' });
-    const AsyncStore = createAsyncStore('AsyncStore', DummyModel, () => ({
-      async fetchOne() {
-        return dummyItem;
-      },
-    }));
+    const AsyncStore = createAsyncStore({
+      name: 'AsyncStore',
+      itemModel: DummyModel,
+      fetchActions: () => ({
+        async fetchOne() {
+          return dummyItem;
+        },
+      }),
+    });
     const asyncStore = AsyncStore.create();
     const container = asyncStore.getOne('foo');
     await when(() => container.isReady);
@@ -34,11 +44,15 @@ describe('createAsyncStore', () => {
   it('should fetch many items', async () => {
     const dummyItem1 = DummyModel.create({ id: 'foo' });
     const dummyItem2 = DummyModel.create({ id: 'bar' });
-    const AsyncStore = createAsyncStore('AsyncStore', DummyModel, () => ({
-      async fetchMany() {
-        return [dummyItem1, dummyItem2];
-      },
-    }));
+    const AsyncStore = createAsyncStore({
+      name: 'AsyncStore',
+      itemModel: DummyModel,
+      fetchActions: () => ({
+        async fetchMany() {
+          return [dummyItem1, dummyItem2];
+        },
+      }),
+    });
     const asyncStore = AsyncStore.create();
     const containers = asyncStore.getMany(['foo', 'bar']);
     await when(() => asyncStore.isReady);
@@ -50,11 +64,15 @@ describe('createAsyncStore', () => {
   it('should fetch all items', async () => {
     const dummyItem1 = DummyModel.create({ id: 'foo' });
     const dummyItem2 = DummyModel.create({ id: 'bar' });
-    const AsyncStore = createAsyncStore('AsyncStore', DummyModel, () => ({
-      async fetchAll() {
-        return [dummyItem1, dummyItem2];
-      },
-    }));
+    const AsyncStore = createAsyncStore({
+      name: 'AsyncStore',
+      itemModel: DummyModel,
+      fetchActions: () => ({
+        async fetchAll() {
+          return [dummyItem1, dummyItem2];
+        },
+      }),
+    });
     const asyncStore = AsyncStore.create();
     asyncStore.getAll();
     await when(() => asyncStore.isReady);
@@ -65,11 +83,15 @@ describe('createAsyncStore', () => {
   });
 
   it('should fail to fetch one item', async () => {
-    const AsyncStore = createAsyncStore('AsyncStore', DummyModel, () => ({
-      async fetchOne() {
-        throw Error('Failed to fetch item');
-      },
-    }));
+    const AsyncStore = createAsyncStore({
+      name: 'AsyncStore',
+      itemModel: DummyModel,
+      fetchActions: () => ({
+        async fetchOne() {
+          throw Error('Failed to fetch item');
+        },
+      }),
+    });
     const asyncStore = AsyncStore.create();
     const container = asyncStore.getOne('foo');
     await when(() => container.isReady);
@@ -79,11 +101,15 @@ describe('createAsyncStore', () => {
   });
 
   it('should fail to fetch many items', async () => {
-    const AsyncStore = createAsyncStore('AsyncStore', DummyModel, () => ({
-      async fetchMany() {
-        throw Error('Failed to fetch items');
-      },
-    }));
+    const AsyncStore = createAsyncStore({
+      name: 'AsyncStore',
+      itemModel: DummyModel,
+      fetchActions: () => ({
+        async fetchMany() {
+          throw Error('Failed to fetch items');
+        },
+      }),
+    });
     const asyncStore = AsyncStore.create();
     const containers = asyncStore.getMany(['foo', 'bar']);
     await when(() => asyncStore.isReady);
@@ -95,23 +121,32 @@ describe('createAsyncStore', () => {
   });
 
   it('should throw exception when not supporting fetchOne', async () => {
-    const AsyncStore = createAsyncStore('AsyncStore', DummyModel);
+    const AsyncStore = createAsyncStore({
+      name: 'AsyncStore',
+      itemModel: DummyModel,
+    });
     const asyncStore = AsyncStore.create();
     expect(asyncStore._fetchOne('foo')).rejects.toEqual(
       Error("Store doesn't support fetchOne")
     );
   });
 
   it('should throw exception when not supporting fetchMany', async () => {
-    const AsyncStore = createAsyncStore('AsyncStore', DummyModel);
+    const AsyncStore = createAsyncStore({
+      name: 'AsyncStore',
+      itemModel: DummyModel,
+    });
     const asyncStore = AsyncStore.create();
     expect(asyncStore._fetchMany(['foo', 'bar'])).rejects.toEqual(
       Error("Store doesn't support fetchMany")
     );
   });
 
   it('should throw exception when not supporting fetchAll', async () => {
-    const AsyncStore = createAsyncStore('AsyncStore', DummyModel);
+    const AsyncStore = createAsyncStore({
+      name: 'AsyncStore',
+      itemModel: DummyModel,
+    });
     const asyncStore = AsyncStore.create();
     expect(asyncStore._fetchAll()).rejects.toEqual(
       Error("Store doesn't support fetchAll")

src/createAsyncStore.ts

@@ -30,20 +30,27 @@ export interface VolatileAsyncStoreState {
   error?: Error;
 }
 
-export interface AsyncStoreOptions {
+export interface AsyncStoreOptions<T extends IAnyModelType> {
+  name?: string;
+  itemModel: T;
   ttl?: number;
   failstateTtl?: number;
   batch?: number;
+  fetchActions?: AsyncFetchActions<T>;
 }
 
 export function createAsyncStore<T extends IAnyModelType>(
-  name: string,
-  ItemModel: T,
-  fetchActions?: AsyncFetchActions<T>,
-  options?: AsyncStoreOptions
+  options: AsyncStoreOptions<T>
 ) {
-  const { ttl = 0, failstateTtl = 10000, batch = 40 } = options || {};
-  const AsyncContainer = createAsyncContainer<T>(ItemModel, {
+  const {
+    name = 'AnonymouseAsyncStore',
+    itemModel,
+    ttl = 0,
+    failstateTtl = 10000,
+    batch = 40,
+    fetchActions,
+  } = options;
+  const AsyncContainer = createAsyncContainer<T>(itemModel, {
     ttl,
     failstateTtl,
   });