feat(queryDocuments): add skip to query options

Author: TillaTheHun0

deno.lock

@@ -3,7 +3,7 @@
  */
 // @deno-types="./crocks.d.ts"
 export { default as crocks } from 'https://cdn.skypack.dev/[email protected]'
-export * as R from 'https://cdn.skypack.dev/ramda@^0.29.0?dts'
+export * as R from 'https://cdn.skypack.dev/[email protected]?dts'
 
 export { EJSON } from 'npm:[email protected]'
 export { type Collection, MongoClient } from 'npm:[email protected]'

deps.ts

@@ -320,6 +320,40 @@ async (
           ],
         })
 
+        const withSkip = await a.queryDocuments({
+          db: DB,
+          query: {
+            selector: { year: { $lte: '1978' } },
+            fields: ['_id', 'genre', 'year'],
+            sort: [{ title: 'DESC' }, { year: 'DESC' }],
+            skip: 2,
+          },
+        })
+
+        assertObjectMatch(withSkip as any, {
+          ok: true,
+          docs: [
+            { _id: '10-caddyshack', year: '1978', genre: ['comedy'] },
+          ],
+        })
+
+        const withLimit = await a.queryDocuments({
+          db: DB,
+          query: {
+            selector: { year: { $lte: '1978' } },
+            fields: ['_id', 'genre', 'year'],
+            sort: [{ title: 'DESC' }, { year: 'DESC' }],
+            limit: 1,
+          },
+        })
+
+        assertObjectMatch(withLimit as any, {
+          ok: true,
+          docs: [
+            { _id: '15-starwars', year: '1976', genre: ['sci-fi'] },
+          ],
+        })
+
         await a.removeDatabase(DB)
       },
     )

test/suite.ts

@@ -54,6 +54,11 @@ Deno.test('utils', async (t) => {
       assertEquals(res, { limit: 25 })
     })
 
+    await t.step('should map the skip', () => {
+      const res = queryOptions({ skip: 25 })
+      assertObjectMatch(res, { skip: 25 })
+    })
+
     await t.step('should map fields to projection', () => {
       const res = queryOptions({ fields: ['_id', 'foo', 'bar'] })
       assertObjectMatch(res, { projection: { foo: 1, bar: 1, _id: 1 } })

utils.test.ts

@@ -31,10 +31,12 @@ export const toBulkOperations = map(
 
 export const queryOptions = ({
   limit,
+  skip,
   fields,
   sort,
 }: {
   limit?: number | string
+  skip?: number | string
   fields?: string[]
   sort?: string[] | { [field: string]: 'ASC' | 'DESC' }[]
 }) => {
@@ -46,13 +48,15 @@ export const queryOptions = ({
    */
   const options: {
     limit?: number
+    skip?: number
     projection?: { [field: string]: 0 | 1 }
     sort?: { [field: string]: 1 | -1 }
   } = {
     /**
      * See https://www.mongodb.com/docs/manual/reference/operator/aggregation/limit/
      */
     ...(limit ? { limit: Number(limit) } : { limit: 25 }),
+    ...(skip ? { skip: Number(skip) } : {}),
     ...(fields
       ? {
         projection: fields.reduce(
@@ -86,8 +90,8 @@ export const queryOptions = ({
  */
 export const mapSort = (
   sort: string[] | { [field: string]: 'ASC' | 'DESC' }[],
-) => {
-  if (!sort || !sort.length) return sort
+): { [field: string]: 1 | -1 } => {
+  if (!sort || !sort.length) return {}
 
   // deno-lint-ignore ban-ts-comment
   // @ts-ignore