docs(filter): Moves filter docs into options for simplicity.

Author: ryasmi

docs/filter.md

@@ -12,7 +12,7 @@ The [facade](./facade.md) contains common functions for storage and retrieval of
 - [replaceEntity](#replaceentity)
 
 ### countEntities
-Counts the number of entities that match the [`filter`](./filter.md) option.
+Counts the number of entities that match the [`filter`](./options.md#filter) option.
 
 ```ts
 const { count } = await facade.countEntities({
@@ -44,7 +44,7 @@ try {
 This package contains the [create entity tests](../src/tests/createEntity) and the [create entity signature](../src/signatures/CreateEntity.ts) for this function.
 
 ### getEntities
-Retreives a sorted paginated array of entities that match the [`filter`](./filter.md) option.
+Retreives a sorted paginated array of entities that match the [`filter`](./options.md#filter) option.
 
 ```ts
 const { entities, nextCursor, previousCursor } = await facade.getEntities({
@@ -67,7 +67,7 @@ const firstPage = await facade.getEntities({
 This package contains the [get entities tests](../src/tests/getEntities) and the [get entities signature](../src/signatures/GetEntities.ts) for this function.
 
 ### getEntity
-Retrieves a single entity that matches the [`id`](./options.md#id) and [`filter`](./filter.md) options.
+Retrieves a single entity that matches the [`id`](./options.md#id) and [`filter`](./options.md#filter) options.
 
 ```ts
 import MissingEntityError from 'js-entity-repos/core/dist/errors/MissingEntityError';
@@ -88,7 +88,7 @@ try {
 This package contains the [get entity tests](../src/tests/getEntity) and the [get entity signature](../src/signatures/GetEntity.ts) for this function.
 
 ### patchEntity
-For an entity that matches the [`id`](./options.md#id) and [`filter`](./filter.md) options, it changes some of an entity's properties using the [`patch`](./options.md#patch) option.
+For an entity that matches the [`id`](./options.md#id) and [`filter`](./options.md#filter) options, it changes some of an entity's properties using the [`patch`](./options.md#patch) option.
 
 ```ts
 import MissingEntityError from 'js-entity-repos/core/dist/errors/MissingEntityError';
@@ -110,7 +110,7 @@ try {
 This package contains the [patch entity tests](../src/tests/patchEntity) and the [patch entity signature](../src/signatures/PatchEntity.ts) for this function.
 
 ### removeEntities
-Removes all entities that match the [`filter`](./filter.md) option.
+Removes all entities that match the [`filter`](./options.md#filter) option.
 
 ```ts
 await facade.removeEntities({
@@ -121,7 +121,7 @@ await facade.removeEntities({
 This package contains the [remove entities tests](../src/tests/removesEntities) and the [remove entities signature](../src/signatures/RemoveEntities.ts) for this function.
 
 ### removeEntity
-Removes an entity that matches the [`id`](./options.md#id) and [`filter`](./filter.md) options.
+Removes an entity that matches the [`id`](./options.md#id) and [`filter`](./options.md#filter) options.
 
 ```ts
 import MissingEntityError from 'js-entity-repos/core/dist/errors/MissingEntityError';
@@ -142,7 +142,7 @@ try {
 This package contains the [remove entity tests](../src/tests/removesEntity) and the [remove entity signature](../src/signatures/RemoveEntity.ts) for this function.
 
 ### replaceEntity
-For an entity that matches the [`id`](./options.md#id) and [`filter`](./filter.md) options, it changes all of an entity's properties using the [`entity`](./options.md#entity) option.
+For an entity that matches the [`id`](./options.md#id) and [`filter`](./options.md#filter) options, it changes all of an entity's properties using the [`entity`](./options.md#entity) option.
 
 ```ts
 import MissingEntityError from 'js-entity-repos/core/dist/errors/MissingEntityError';

docs/functions.md

@@ -5,7 +5,7 @@ The [facade](./facade.md) [functions](./functions.md) have some common options t
 - [Id](#id)
 - [Entity](#entity)
 - [Patch](#patch)
-- [Filter](./filter.md)
+- [Filter](#filter.md)
 - [Sort](#sort)
 - [Pagination](#pagination)
 
@@ -36,7 +36,69 @@ interface TodoEntity extends Entity {
 This is an object containing some of the entity's properties. This package uses [TypeScript's Partial type](https://www.typescriptlang.org/docs/handbook/advanced-types.html) applied to an [Entity](#entity) (using `Partial<Entity>`).
 
 ### Filter
-This is an object that filters the entities. More information can be found in the [filter documentation](./filter.md). This package contains the [TypeScript Filter type definition](../src/types/Filter.ts).
+This is an object that filters the entities. The [filter type definition](../src/types/Filter.ts) currently supports the following operators which have been [borrowed from Mongo](https://docs.mongodb.com/manual/reference/operator/query/).
+
+Operator | Description
+--- | ---
+[$and](https://docs.mongodb.com/manual/reference/operator/query/and/#op._S_and) | Includes entities where all of the specified filters are true.
+[$or](https://docs.mongodb.com/manual/reference/operator/query/or/#op._S_or) | Includes entities where some of the specified filters are true.
+[$nor](https://docs.mongodb.com/manual/reference/operator/query/nor/#op._S_nor) | Includes entities where some of the specified filters are false.
+[$not](https://docs.mongodb.com/manual/reference/operator/query/no/#op._S_no) | Includes entities where a specified filter is not true.
+[$eq](https://docs.mongodb.com/manual/reference/operator/query/eq/#op._S_eq) | Includes entities where the value of a given property is equal to the specified value.
+[$ne](https://docs.mongodb.com/manual/reference/operator/query/ne/#op._S_ne) | Includes entities where the value of a given property is not equal to the specified value.
+[$lt](https://docs.mongodb.com/manual/reference/operator/query/lt/#op._S_lt) | Includes entities where the value of a given property is less than the specified value.
+[$lte](https://docs.mongodb.com/manual/reference/operator/query/lt/#op._S_lt) | Includes entities where the value of a given property is less than or equal to the specified value.
+[$gt](https://docs.mongodb.com/manual/reference/operator/query/gt/#op._S_gt) | Includes entities where the value of a given property is greater than the specified value.
+[$gte](https://docs.mongodb.com/manual/reference/operator/query/gt/#op._S_gt) | Includes entities where the value of a given property is greater than or equal to the specified value.
+[$in](https://docs.mongodb.com/manual/reference/operator/query/in/#op._S_in) | Includes entities where the value of a given property is equal to one of the specified values.
+[$nin](https://docs.mongodb.com/manual/reference/operator/query/ni/#op._S_ni) | Includes entities where the value of a given property is not equal to any of the specified values.
+
+The filter below is comprehensive example using all of the operators.
+
+```json
+{
+  "$or": [
+    {
+      "numberProp1": {
+        "$not": {
+          "$gt": 0,
+          "$lt": 1
+        }
+      }
+    },
+    {
+      "$and": [
+        {
+          "stringProp1": "string value 1",
+          "numberProp2": {
+            "$gte": 0,
+            "$lte": 1
+          },
+          "numberProp3": { "$ne": 0 },
+          "numberProp4": { "$eq": 0 }
+        },
+        {
+          "stringProp2": {
+            "$in": ["string value 2", "string value 3"]
+          },
+          "stringProp3": {
+            "$nin": ["string value 4", "string value 5"]
+          }
+        }
+      ]
+    },
+    ,
+    {
+      "$nor": [
+        {
+          "stringProp4": "string value 6"
+        }
+      ]
+    }
+  ]
+}
+```
+
 
 ### Sort
 This is an object where a key represents the entity property to be sorted and the value represents the direction to sort. The value should be `true` to sort in ascending order and `false` to sort in descending order. The properties are sorted in order of their definition in the sort option, for example, the following sort option `{ createdAt: false, id: true }` will sort by the `createdAt` property first and then the the `id` property.