arrayRequestBody helper

Author: ajaishankar

README.md

@@ -179,4 +179,15 @@ type Ret = FetchReturnType<typeof findPetsByStatus>
 type Err = FetchErrorType<typeof findPetsByStatus>
 ```
 
+### Utility Methods
+
+- `arrayRequestBody` - Helper to merge params when request body is an array
+
+```ts
+
+const body = arrayRequestBody([{ item: 1}], { param: 2})
+
+// body type is { item: number }[] & { param: number }
+```
+
 Happy fetching! 👍

src/index.ts

@@ -1,4 +1,5 @@
 import { Fetcher } from './fetcher'
+import { arrayRequestBody } from './utils'
 
 import type {
   ApiResponse,
@@ -28,4 +29,4 @@ export type {
   TypedFetch,
 }
 
-export { Fetcher, ApiError }
+export { Fetcher, ApiError, arrayRequestBody }

src/utils.ts

@@ -0,0 +1,6 @@
+/**
+ * Helper to merge params when request body is an array
+ */
+export function arrayRequestBody<T, O>(array: T[], params?: O): T[] & O {
+  return Object.assign([...array], params)
+}

test/fetch.test.ts

@@ -1,7 +1,7 @@
 import 'whatwg-fetch'
 
 import { server } from './mocks/server'
-import { ApiError, Fetcher } from '../src'
+import { ApiError, arrayRequestBody, Fetcher } from '../src'
 import { Data, paths } from './paths'
 
 beforeAll(() => server.listen())
@@ -68,7 +68,7 @@ describe('fetch', () => {
     it(`${method.toUpperCase()} /bodyarray/{id}`, async () => {
       const fun = fetcher.path('/bodyarray/{id}').method(method).create()
 
-      const { data } = await fun(Object.assign(['b', 'c'], { id: 1 }))
+      const { data } = await fun(arrayRequestBody(['b', 'c'], { id: 1 }))
 
       expect(data.params).toEqual({ id: '1' })
       expect(data.body).toEqual(['b', 'c'])

test/utils.test.ts

@@ -0,0 +1,10 @@
+import { arrayRequestBody } from '../src'
+
+describe('utils', () => {
+  it('array request body with params', () => {
+    const body = arrayRequestBody([{ item: 2 }], { param: 3 })
+    expect(body.length).toEqual(1)
+    expect(body[0].item).toEqual(2)
+    expect(body.param).toEqual(3)
+  })
+})