feat: ✨ add remove param option

Author: chantouchsek

src/core/BaseService.ts

@@ -1,4 +1,3 @@
-import type { ValidatorType } from './Validator'
 import type { AxiosError, AxiosInstance, Method, AxiosRequestConfig, AxiosResponse } from 'axios'
 import type { IParseOptions } from 'qs'
 import { isObject, isArray } from 'lodash'
@@ -13,23 +12,18 @@ interface AxiosResponseData {
   [key: string | number]: any
 }
 
-class BaseService {
-  errors: ValidatorType
-  parameters: Record<string, any>
-  endpoint: string
+export default class BaseService {
+  public errors = Validator
   static $http: AxiosInstance
   static $errorProperty = 'errors'
+  static $removeParams? = false
   static $parsedQs: IParseOptions = {
     comma: true,
     allowDots: true,
     ignoreQueryPrefix: true,
   }
 
-  constructor(endpoint: string, parameters: Record<string, any>) {
-    this.endpoint = endpoint
-    this.parameters = parameters
-    this.errors = Validator
-  }
+  constructor(readonly endpoint: string, public parameters: Record<string, any>) {}
 
   get $http() {
     return BaseService.$http
@@ -39,6 +33,10 @@ class BaseService {
     return BaseService.$errorProperty
   }
 
+  get $removeParams() {
+    return BaseService.$removeParams
+  }
+
   get $parsedQs() {
     return BaseService.$parsedQs
   }
@@ -85,15 +83,7 @@ class BaseService {
     return this.delete<T>(id)
   }
 
-  submit<T = any>(method: Method, url?: string | number, form?: any, config?: AxiosRequestConfig) {
-    return new Promise<T>((resolve, reject) => {
-      this.$submit<T>(method, url, form, config)
-        .then(({ data }) => resolve(data))
-        .catch((err) => reject(err))
-    })
-  }
-
-  $submit<T = any>(method: Method, param?: string | number, form?: any, config?: AxiosRequestConfig) {
+  $submit<T = any, F = any>(method: Method, param?: string | number, form?: F, config?: AxiosRequestConfig) {
     this.beforeSubmit()
     return new Promise<AxiosResponse<T>>((resolve, reject) => {
       const data = hasFiles(form) ? objectToFormData(form) : form
@@ -117,6 +107,15 @@ class BaseService {
           }
           reject(error)
         })
+      if (this.$removeParams) this.removeParameters()
+    })
+  }
+
+  submit<T = any, F = any>(method: Method, url?: string | number, form?: F, config?: AxiosRequestConfig) {
+    return new Promise<T>((resolve, reject) => {
+      this.$submit<T>(method, url, form, config)
+        .then(({ data }) => resolve(data))
+        .catch((err) => reject(err))
     })
   }
 
@@ -125,14 +124,14 @@ class BaseService {
     return `${url}${query}`
   }
 
-  setParameters(parameters: Record<string, any>): this {
+  setParameters(parameters: Record<string, any>) {
     Object.keys(parameters).forEach((key) => {
       this.parameters[key] = parameters[key]
     })
     return this
   }
 
-  setParameter(parameter: string, value?: any): this {
+  setParameter(parameter: string, value?: any) {
     if (!value) {
       const options: IParseOptions = Object.assign({}, this.$parsedQs, {
         comma: true,
@@ -146,7 +145,7 @@ class BaseService {
     return this
   }
 
-  removeParameters(parameters = [] as any[]): this {
+  removeParameters(parameters: string[] = []) {
     if (!parameters || !parameters.length) {
       this.parameters = []
     } else if (isArray(parameters)) {
@@ -155,7 +154,7 @@ class BaseService {
     return this
   }
 
-  removeParameter(parameter: string): this {
+  removeParameter(parameter: string) {
     delete this.parameters[parameter]
     return this
   }
@@ -182,5 +181,3 @@ class BaseService {
     validator.successful = true
   }
 }
-
-export default BaseService

src/core/Validator.ts

@@ -2,14 +2,12 @@ import { cloneDeep, get, has, omit } from 'lodash'
 import { is, toCamelCase, toSnakeCase } from '../util'
 
 class Validator {
-  public errors: Record<string, any>
   public successful: boolean
   public processing: boolean
 
-  constructor(errors: Record<string, any> = {}) {
+  constructor(public errors: Record<string, any> = {}) {
     this.processing = false
     this.successful = false
-    this.errors = errors
   }
 
   add(field: string, message: string, forceUpdate?: boolean) {

src/index.ts

@@ -8,21 +8,32 @@ import Validator from './core/Validator'
 // augment typings of Vue.js
 import './vue'
 
-class AxiosHttp {
-  installed = false
-  parsedQs: IParseOptions = {
+interface ModuleOptions {
+  removeParams?: boolean
+  parsedQs: IParseOptions
+  errorProperty?: string | 'errors' | 'message'
+}
+const optionDefault: ModuleOptions = {
+  removeParams: false,
+  parsedQs: {
     comma: true,
     allowDots: true,
     ignoreQueryPrefix: true,
-  }
-  install(Vue: typeof _Vue, options: Record<string, any> = {}) {
+  },
+  errorProperty: 'errors',
+}
+
+class AxiosHttp {
+  installed = false
+  install(Vue: typeof _Vue, options: Partial<ModuleOptions> = {}) {
     if (this.installed) return
+
     this.installed = true
-    const defaultOption = merge({ parsedQs: this.parsedQs, errorProperty: 'errors' }, options)
-    const { $axios, errorProperty, parsedQs } = defaultOption
-    BaseService.$http = $axios
-    BaseService.$errorProperty = errorProperty || 'errors'
+    const { errorProperty, parsedQs, removeParams } = merge(optionDefault, options)
+
     BaseService.$parsedQs = parsedQs
+    BaseService.$removeParams = removeParams
+    BaseService.$errorProperty = errorProperty || 'errors'
     Vue.mixin({
       beforeCreate() {
         this.$options.$errors = {} as never
@@ -41,6 +52,6 @@ class AxiosHttp {
 }
 
 export * from './util'
-export type { ValidatorType }
+export type { ValidatorType, ModuleOptions }
 export { Validator, BaseService }
 export default new AxiosHttp()