lowcodeutils/index.d.ts

a fontend utils for write repeated code

declare namespace lowcodeutils {
  /**
   * @description:自定义抛出错误
   * @param {any} config 配置项
   * @param {boolean | boolean[]} checks 判断条件
   * @param {string} message 报错信息
   * @return {*}
   */
  export function throwExceptionIf(config: any, checks: boolean[] | boolean, message: string): any
  /**
   * @description: 获取入参类型
   * @param {any} param
   * @return {String}
   */
  export function getType(param: any): string
  /**
   * @description: 判断是否为数字
   * @param {any} param
   * @return {Boolean}
   */
  export function isNmuber(param: any): boolean
  /**
   * @description: 判断是否为字符串
   * @param {any} param
   * @return {Boolean}
   */
  export function isString(param: any): boolean
  /**
   * @description: 判断是否为布尔
   * @param {any} param
   * @return {Boolean}
   */
  export function isBoolean(param: any): boolean
  /**
   * @description: 判断是否为对象
   * @param {any} param
   * @return {Boolean}
   */
  export function isObject(param: any): boolean
  /**
   * @description: 判断是否为数组
   * @param {any} param
   * @return {Boolean}
   */
  export function isArray(param: any): boolean
  /**
   * @description: 判断两个数组是否相同
   * @param {Array} arr1
   * @param {Array} arr2
   * @return {Boolean}
   */
  export function equalArray(arr1: Array<any>, arr2: Array<any>): boolean
  /**
   * @description:返回数组的前N项数组
   * @param {Array} arr
   * @param {number} num
   * @return {*}
   */
  export function nArray(arr: Array<any>, num: number): Array<any>
  /**
   * @description: 平铺数组
   * @param {any} arr
   * @return {*}
   */
  export function flatArray(arr: any[]): Array<any>

  /**
   * @description:转换对象成一个可配置的对象
   * @param {*}
   * @return {*}
   * @example
   * const newObject = transferNewObject({ foo: 'bar' }, (key, value) => [value, key]) // {bar: 'foo'}
   * const newObject = transferNewObject({ FOO: true, bAr: { bAz: true } }, (key, value) => [key.toLowerCase(), value]) // {foo: true, bar: {bAz: true}}
   * const newObject = transferNewObject({ FOO: true, bAr: { bAz: true } }, (key, value) => [key.toLowerCase(), value], {
   *  deep: true
   * }) // {foo: true, bar: {baz: true}
   */
  export function transferNewObject(
    obj: {
      [key: string]: any
    },
    fn: () => any,
    config: {
      deep: boolean
    }
  ): {
    [key: string]: any
  }

  /**
   * @description: 执行等待
   * @param {number} time
   * @return {*}
   */
  export function sleep(time: number): Promise<any>
  /**
   * @description: 串行promise，依次执行，集中返回
   * @param {Array} tasks
   * @return {*}
   */
  export function serialPromise(tasks: Array<() => Promise<any>>): Promise<any>
}

declare module "lowcodeutils" {
  export = lowcodeutils
}