docs(kitsu-core): add examples for filterIncludes

Author: wopian

packages/kitsu-core/src/filterIncludes/index.js

@@ -1,13 +1,34 @@
 import { error } from '../error'
 
 /**
- * Filters includes for the specific relationship
+ * Filters includes for the specific relationship requested
  *
  * @param {Object} included The response included object
- * @param {Object} opts
- * @param {string} opts.id The relationship ID
- * @param {string} opts.type The relationship type
+ * @param {Object} relationship
+ * @param {string} relationship.id The relationship ID
+ * @param {string} relationship.type The relationship type
  * @returns {Array} The matched includes
+ *
+ * @example
+ * const includes = [
+ *   {
+ *     id: '1',
+ *     type: 'users',
+ *     attributes: { name: 'Emma' }
+ *   },
+ *   {
+ *     id: '2',
+ *     type: 'users',
+ *     attributes: { name: 'Josh' }
+ *   }
+ * ]
+ * const relationship = { id: '1', type: 'users' }
+ * const response = filterIncludes(includes, relationship)
+ * // {
+ * //   id: '1',
+ * //   type: 'users',
+ * //   attributes: { name: 'Emma' }
+ * // }
  */
 export function filterIncludes (included, { id, type }) {
   try {

packages/kitsu-core/src/filterIncludes/index.spec.js

@@ -19,5 +19,37 @@ describe('kitsu-core', () => {
       const response = filterIncludes([], { })
       expect(response).toEqual({ })
     })
+
+    it('filters included relationships', () => {
+      expect.assertions(1)
+      const includes = [
+        {
+          id: '1',
+          type: 'users',
+          attributes: {
+            name: 'Emma'
+          }
+        },
+        {
+          id: '2',
+          type: 'users',
+          attributes: {
+            name: 'Josh'
+          }
+        }
+      ]
+      const relationship = {
+        id: '1',
+        type: 'users'
+      }
+      const response = filterIncludes(includes, relationship)
+      expect(response).toEqual({
+        id: '1',
+        type: 'users',
+        attributes: {
+          name: 'Emma'
+        }
+      })
+    })
   })
 })