feat(cache): readItems new limit option

Author: Akryum

packages/shared/src/types/cache.ts

@@ -65,6 +65,10 @@ export interface Cache<
      * Filter the items to include.
      */
     filter?: (item: WrappedItem<TModel, TModelDefaults, TSchema>) => boolean
+    /**
+     * Limit the number of items returned.
+     */
+    limit?: number
   }) => Array<WrappedItem<TModel, TModelDefaults, TSchema>>
 
   writeItems: <TModel extends Model = Model>(params: {

packages/vue/src/cache.ts

@@ -52,12 +52,13 @@ export function createCache<
     readItem({ model, key }) {
       return getWrappedItem(model, state.value[model.name]?.[key])
     },
-    readItems({ model, marker, filter }) {
+    readItems({ model, marker, filter, limit }) {
       if (marker && !state.value._markers?.[marker]) {
         return []
       }
       const data: Array<ResolvedModelItemBase<any, any, any>> = Object.values(state.value[model.name] ?? {})
       const result: Array<WrappedItem<any, any, any>> = []
+      let count = 0
       for (const item of data) {
         if (item) {
           if (filter && !filter(item)) {
@@ -66,6 +67,10 @@ export function createCache<
           const wrappedItem = getWrappedItem(model, item)
           if (wrappedItem) {
             result.push(wrappedItem)
+            count++
+            if (limit != null && count >= limit) {
+              break
+            }
           }
         }
       }

packages/vue/test/cache.spec.ts

@@ -147,4 +147,27 @@ describe('cache', () => {
     expect(items2).toHaveLength(1)
     expect(items2[0]).toEqual({ id: 2, label: 'Woof' })
   })
+
+  it('should limit the number of items', () => {
+    const cache = createCache({ getStore })
+    cache.writeItem({ model: mockModel, key: 1, item: { id: 1, label: 'Item 1' }, marker: 'testMarker' })
+    cache.writeItem({ model: mockModel, key: 2, item: { id: 2, label: 'Item 2' }, marker: 'testMarker' })
+    cache.writeItem({ model: mockModel, key: 3, item: { id: 3, label: 'Item 3' }, marker: 'testMarker' })
+
+    const items = cache.readItems({ model: mockModel, marker: 'testMarker', limit: 2 })
+    expect(items).toHaveLength(2)
+    expect(items[0]).toEqual({ id: 1, label: 'Item 1' })
+    expect(items[1]).toEqual({ id: 2, label: 'Item 2' })
+  })
+
+  it('should filter and limit the items', () => {
+    const cache = createCache({ getStore })
+    cache.writeItem({ model: mockModel, key: 1, item: { id: 1, label: 'Meow' }, marker: 'testMarker' })
+    cache.writeItem({ model: mockModel, key: 2, item: { id: 2, label: 'Woof' }, marker: 'testMarker' })
+    cache.writeItem({ model: mockModel, key: 3, item: { id: 3, label: 'Meow' }, marker: 'testMarker' })
+
+    const items = cache.readItems({ model: mockModel, marker: 'testMarker', filter: item => item.label === 'Meow', limit: 1 })
+    expect(items).toHaveLength(1)
+    expect(items[0]).toEqual({ id: 1, label: 'Meow' })
+  })
 })