chore(entities): 🤖 remove getManyByPredicate

ngneat · Dec 4, 2023 · 215de29 · 215de29
1 parent c171d4f
commit 215de29
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 147 deletions.
diff --git a/docs/docs/features/entities-management/entities.mdx b/docs/docs/features/entities-management/entities.mdx
@@ -236,19 +236,9 @@ Get first entity from the store by predicate:
 ```ts
 import { getEntityByPredicate } from '@ngneat/elf-entities';
 
-const todo = todosStore.query(getEntityByPredicate(({ title }) => title === 'Elf'));
-```
-
-### `getManyByPredicate`
-
-Get multiple entities from the store by predicate:
-
-```ts
-import { getManyByPredicate } from '@ngneat/elf-entities';
-
-const todo = todosStore.query(getManyByPredicate(({ active }) => active));
-const todo = todosStore.query(getManyByPredicate(({ active }) => active), { pluck: 'title });
-const todo = todosStore.query(getManyByPredicate(({ active }) => active), { ref: UIEntitiesRef, pluck: 'title });
+const todo = todosStore.query(
+  getEntityByPredicate(({ title }) => title === 'Elf')
+);
 ```
 
 ### `hasEntity`

diff --git a/packages/entities/src/lib/queries.spec.ts b/packages/entities/src/lib/queries.spec.ts
@@ -12,7 +12,6 @@ import {
   hasEntity,
   getEntitiesIds,
   getEntityByPredicate,
-  getManyByPredicate,
 } from './queries';
 import { addEntities } from './add.mutation';
 import { UIEntitiesRef } from './entity.state';
@@ -196,99 +195,4 @@ describe('queries', () => {
       ]
     `);
   });
-
-  describe('getManyByPredicate', () => {
-    it('should return the collection', () => {
-      const store = createEntitiesStore();
-      store.update(addEntities(createTodo(1)));
-      store.update(addEntities(createTodo(2)));
-      store.update(addEntities(createTodo(3)));
-      store.update(addEntities(createTodo(4)));
-      expect(
-        store.query(getManyByPredicate((el: Todo) => [2, 3].includes(el.id)))
-      ).toMatchInlineSnapshot(`
-        Array [
-          Object {
-            "completed": false,
-            "id": 2,
-            "title": "todo 2",
-          },
-          Object {
-            "completed": false,
-            "id": 3,
-            "title": "todo 3",
-          },
-        ]
-      `);
-    });
-    it('should work with pluck', () => {
-      const store = createEntitiesStore();
-      store.update(addEntities(createTodo(1)));
-      store.update(addEntities(createTodo(2)));
-      store.update(addEntities(createTodo(3)));
-      store.update(addEntities(createTodo(4)));
-      expect(
-        store.query(
-          getManyByPredicate((el: Todo) => [4, 3].includes(el.id), {
-            pluck: 'id',
-          })
-        )
-      ).toMatchInlineSnapshot(`
-        Array [
-          3,
-          4,
-        ]
-      `);
-    });
-
-    it('should work with ref', () => {
-      const store = createUIEntityStore();
-
-      store.update(addEntities(createUITodo(1), { ref: UIEntitiesRef }));
-      store.update(addEntities(createUITodo(2), { ref: UIEntitiesRef }));
-      store.update(addEntities(createUITodo(3), { ref: UIEntitiesRef }));
-      store.update(addEntities(createUITodo(4), { ref: UIEntitiesRef }));
-      expect(
-        store.query(
-          getManyByPredicate(
-            (el: { id: number; open: boolean }) => [2, 3].includes(el.id),
-            { ref: UIEntitiesRef }
-          )
-        )
-      ).toMatchInlineSnapshot(`
-        Array [
-          Object {
-            "id": 2,
-            "open": false,
-          },
-          Object {
-            "id": 3,
-            "open": false,
-          },
-        ]
-      `);
-    });
-
-    it('should work with ref and pluck', () => {
-      const store = createUIEntityStore();
-
-      store.update(addEntities(createUITodo(1), { ref: UIEntitiesRef }));
-      store.update(addEntities(createUITodo(2), { ref: UIEntitiesRef }));
-      store.update(addEntities(createUITodo(3), { ref: UIEntitiesRef }));
-      store.update(addEntities(createUITodo(4), { ref: UIEntitiesRef }));
-      expect(
-        store.query(
-          getManyByPredicate(
-            (el: { id: number; open: boolean }) => [2, 3].includes(el.id),
-            { ref: UIEntitiesRef, pluck: 'id' }
-          )
-        )
-      ).toMatchInlineSnapshot(`
-        Array [
-          2,
-          3,
-        ]
-      `);
-    });
-  });
 });
diff --git a/packages/entities/src/lib/queries.ts b/packages/entities/src/lib/queries.ts
@@ -121,44 +121,6 @@ export function getEntityByPredicate<
   };
 }
 
-/**
- *
- * Get many entities by predicate
- *
- * @example
- *
- * store.query(geManyByPredicate(({ active }) => active))
- * store.query(geManyByPredicate((el: Todo) => el.active, { pluck: 'title' }))
- * store.query(geManyByPredicate((el: Todo) => el.active, { ref: UIEntitiesRef, pluck: 'title' }))
- */
-export function getManyByPredicate<
-  S extends EntitiesState<Ref>,
-  R extends getEntityType<S, Ref>[],
-  K extends keyof getEntityType<S, Ref>,
-  Ref extends EntitiesRef = DefaultEntitiesRef
->(
-  predicate: ItemPredicate<getEntityType<S, Ref>>,
-  options?: {
-    pluck?: K | ((entity: getEntityType<S, Ref>) => R);
-  } & BaseEntityOptions<Ref>
-): Query<S, getEntityType<S, Ref>[]> {
-  return function (state) {
-    const { ref: { entitiesKey, idsKey } = defaultEntitiesRef, pluck } =
-      options || {};
-    const filteredEntities: getEntityType<S, Ref>[] = [];
-
-    state[idsKey].forEach((id: getIdType<S, Ref>, index: number) => {
-      const entity = state[entitiesKey][id];
-
-      if (predicate(entity, index)) {
-        filteredEntities.push(checkPluck(entity, pluck));
-      }
-    });
-
-    return filteredEntities;
-  };
-}
-
 /**
  *
  * Check whether the entity exist