chore: id not optional on update as data is required

nuxt-modules · Jan 19, 2023 · 27d9e57 · 27d9e57
1 parent e26e433
commit 27d9e57
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/docs/content/3.usage.md b/docs/content/3.usage.md
@@ -117,7 +117,7 @@ Partially updates an entry by `id` and returns its value. Fields that aren't sen
 
 - **Arguments:**
   - contentType: `string`
-  - id?: `string | number | Partial<T>`
+  - id: `string | number | Partial<T>`
   - data?: `Partial<T>`
 - **Returns:** `Promise<T>`
 
@@ -135,7 +135,7 @@ const onSubmit = async () => {
 ```
 
 ::alert{type="info"}
-This method can be used to update/create a single type entry as `id` is optional.
+This method can be used to update/create a single type entry as you can pass the `data` instead of the `id`.
 ::
 
 > Check out the Strapi [Update an entry](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html#update-an-entry) REST API endpoint.

diff --git a/src/runtime/composables-v3/useStrapi.ts b/src/runtime/composables-v3/useStrapi.ts
@@ -7,7 +7,7 @@ interface StrapiV3Client<T> {
   find<F = T[]>(contentType: string, params?: Strapi3RequestParams): Promise<F>
   findOne<F = T>(contentType: string, id?: string | number | Strapi3RequestParams, params?: Strapi3RequestParams): Promise<F>
   create<F = T>(contentType: string, data: Partial<F>): Promise<F>
-  update<F = T>(contentType: string, id?: string | number | Partial<F>, data?: Partial<F>): Promise<F>
+  update<F = T>(contentType: string, id: string | number | Partial<F>, data?: Partial<F>): Promise<F>
   delete<F = T>(contentType: string, id?: string | number): Promise<F>
 }
 

diff --git a/src/runtime/composables-v3/useStrapi3.ts b/src/runtime/composables-v3/useStrapi3.ts
@@ -73,7 +73,7 @@ export const useStrapi3 = () => {
    * @param  {Record<string, any>} data - Form data
    * @returns Promise<T>
    */
-  const update = <T>(contentType: string, id?: string | number | Partial<T>, data?: Partial<T>): Promise<T> => {
+  const update = <T>(contentType: string, id: string | number | Partial<T>, data?: Partial<T>): Promise<T> => {
     if (typeof id === 'object') {
       data = id
       // @ts-ignore

diff --git a/src/runtime/composables-v4/useStrapi.ts b/src/runtime/composables-v4/useStrapi.ts
@@ -6,7 +6,7 @@ interface StrapiV4Client<T> {
   find<F = T>(contentType: string, params?: Strapi4RequestParams): Promise<Strapi4ResponseMany<F>>
   findOne<F = T>(contentType: string, id?: string | number | Strapi4RequestParams, params?: Strapi4RequestParams): Promise<Strapi4ResponseSingle<F>>
   create<F = T>(contentType: string, data: Partial<F>): Promise<Strapi4ResponseSingle<F>>
-  update<F = T>(contentType: string, id?: string | number | Partial<F>, data?: Partial<F>): Promise<Strapi4ResponseSingle<F>>
+  update<F = T>(contentType: string, id: string | number | Partial<F>, data?: Partial<F>): Promise<Strapi4ResponseSingle<F>>
   delete<F = T>(contentType: string, id?: string | number): Promise<Strapi4ResponseSingle<F>>
 }
 

diff --git a/src/runtime/composables-v4/useStrapi4.ts b/src/runtime/composables-v4/useStrapi4.ts
@@ -62,7 +62,7 @@ export const useStrapi4 = () => {
    * @param  {Record<string, any>} data - Form data
    * @returns Promise<T>
    */
-  const update = <T>(contentType: string, id?: string | number | Partial<T>, data?: Partial<T>): Promise<T> => {
+  const update = <T>(contentType: string, id: string | number | Partial<T>, data?: Partial<T>): Promise<T> => {
     if (typeof id === 'object') {
       data = id
       // @ts-ignore