feat(utils): 新增 utils 方法

新增upperFirst, random, getGlobalThis, isArrayBuffer 等方法

.vscode/settings.json

@@ -1,3 +1,6 @@
 {
-    "docwriter.style": "JSDoc"
+    "docwriter.style": "JSDoc",
+    "cSpell.words": [
+        "vhooks"
+    ]
 }

packages/utils/__tests__/is/is.spec.ts

@@ -32,7 +32,8 @@ import {
   isFormData,
   isStream,
   isUrlSearchParams,
-  isPrimitive
+  isPrimitive,
+  isArrayBuffer
 } from '../../src'
 
 describe('is', () => {
@@ -310,7 +311,7 @@ describe('is', () => {
     expect(isBlob(blob)).toBe(true)
   })
   test('isFile', () => {
-    const filePath = path.join(__dirname, '../../package.json')
+    const filePath = path.join(__dirname, 'is.spec.ts')
     const file = new File(
       [fs.readFileSync(filePath).toString()],
       'package.json',
@@ -333,4 +334,11 @@ describe('is', () => {
     expect(isStream(readStream)).toBe(true)
     expect(isStream(writeStream)).toBe(true)
   })
+
+  test('isArrayBuffer', () => {
+    const buffer = new ArrayBuffer(10)
+    const array = new Array(10)
+    expect(isArrayBuffer(buffer)).toBe(true)
+    expect(isArrayBuffer(array)).toBe(false)
+  })
 })

packages/utils/__tests__/number/number.spec.ts

@@ -0,0 +1,13 @@
+import { random } from '../../src'
+
+describe('number', () => {
+  test('should return random number between min and max', () => {
+    const min = 1
+    const max = 10
+    for (let i = 0; i < max; i++) {
+      const result = random(min, max)
+      expect(result).toBeGreaterThanOrEqual(min)
+      expect(result).toBeLessThanOrEqual(max)
+    }
+  })
+})

packages/utils/__tests__/object/object.spec.ts

@@ -1,6 +1,14 @@
-import { get, isEmpty, set, unset } from '../../src'
+import {
+  get,
+  isEmpty,
+  set,
+  unset,
+  getGlobalThis,
+  isObject,
+  isFunction
+} from '../../src'
 
-describe('utils/common', () => {
+describe('object', () => {
   test('get object', () => {
     const obj: object = { a: 1, b: [1, 2, 3], c: { a: 1, b: 2, c: 3 } }
     expect(get(obj, 'a')).toBe(1)
@@ -62,4 +70,10 @@ describe('utils/common', () => {
     expect(isEmpty(arr)).toBe(false)
     expect(arr[0]).toBeUndefined()
   })
+  test('should return global context', () => {
+    const global = getGlobalThis()
+    expect(isObject(global)).toBe(true)
+    expect(isFunction(global.setTimeout)).toBe(true)
+    expect(isFunction(global.Object)).toBe(true)
+  })
 })

packages/utils/__tests__/string/string.spec.ts

@@ -0,0 +1,9 @@
+import { upperFirst } from '../../src'
+
+describe('string', () => {
+  test('should upperCase first letter', () => {
+    expect(upperFirst('hello world')).toBe('Hello world')
+    expect(upperFirst('HELLO WORLD')).toBe('HELLO WORLD')
+    expect(upperFirst(String({}))).toBe('[object Object]')
+  })
+})

packages/utils/index.js

@@ -1,5 +1,5 @@
 if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./dist/utils.prod.cjs.js')
+  module.exports = require('./dist/utils.cjs.prod.js')
 } else {
   module.exports = require('./dist/utils.cjs.js')
 }

packages/utils/src/index.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: vyron
  * @Date: 2022-04-02 14:12:59
- * @LastEditTime: 2022-05-24 14:16:30
+ * @LastEditTime: 2022-06-01 16:34:29
  * @LastEditors: vyron
  * @Description: 融合汇聚工具类导出
  * @FilePath: /utils/packages/utils/src/index.ts
@@ -12,3 +12,7 @@ export * from './object'
 export * from './array'
 
 export * from './is'
+
+export * from './number'
+
+export * from './string'

packages/utils/src/is/index.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: vyron
  * @Date: 2022-01-10 17:38:09
- * @LastEditTime: 2022-05-24 14:22:53
+ * @LastEditTime: 2022-06-02 14:30:44
  * @LastEditors: vyron
  * @Description: 判断数据类型
  * @FilePath: /utils/packages/utils/src/is/index.ts
@@ -378,3 +378,12 @@ export function isArrayBufferView(value: unknown): value is ArrayBufferView {
   const buffer = (value as any)?.buffer
   return buffer && buffer instanceof ArrayBuffer
 }
+
+/**
+ * Returns whether the value is isArrayBuffer
+ * @param {unknown} value Any legal JavaScript value
+ * @returns {boolean} Returns true if value is isArrayBuffer, otherwise false
+ */
+export function isArrayBuffer(value: unknown): value is ArrayBuffer {
+  return toRawType(value) === 'ArrayBuffer'
+}

packages/utils/src/number/index.ts

@@ -0,0 +1,25 @@
+/*
+ * @Author: vyron
+ * @Date: 2022-06-01 16:26:31
+ * @LastEditTime: 2022-06-01 17:08:12
+ * @LastEditors: vyron
+ * @Description: number utils
+ * @FilePath: /utils/packages/utils/src/number/index.ts
+ */
+
+/**
+ * Returns a random number between the minimum and maximum values.
+ * Configure floating to true to specify decimals and false by default
+ * @param {number} [min=0] - The minimum value
+ * @param {number} [max=1] - The maximum value
+ * @param {boolean} [floating=false] - If true, the number will be a float
+ * @returns {number} - The random number between the minimum and maximum values.
+ */
+export function random(
+  min: number = 0,
+  max: number = 1,
+  floating: boolean = false
+): number {
+  const number = Math.random() * (max - min + 1) + min
+  return floating ? number : Math.floor(number)
+}

packages/utils/src/object/global.ts

@@ -0,0 +1,27 @@
+/*
+ * @Author: vyron
+ * @Date: 2022-06-02 14:13:16
+ * @LastEditTime: 2022-06-02 14:17:35
+ * @LastEditors: vyron
+ * @Description: 获取全局对象
+ * @FilePath: /utils/packages/utils/src/object/global.ts
+ */
+
+const _globalThis =
+  typeof globalThis === 'object' &&
+  globalThis !== null &&
+  globalThis.Object === Object &&
+  globalThis
+
+const _self =
+  typeof self === 'object' && self !== null && self.Object === Object && self
+
+const _global =
+  typeof global === 'object' &&
+  global !== null &&
+  global.Object === Object &&
+  global
+
+export function getGlobalThis(): typeof globalThis {
+  return _globalThis || _global || _self || Function('return this')()
+}

packages/utils/src/object/index.ts

@@ -1,12 +1,13 @@
 /*
  * @Author: vyron
  * @Date: 2022-05-20 14:56:24
- * @LastEditTime: 2022-05-24 14:16:44
+ * @LastEditTime: 2022-06-02 14:31:57
  * @LastEditors: vyron
  * @Description: common utils
  * @FilePath: /utils/packages/utils/src/object/index.ts
  */
 import { isArray, isLength, isNil, isNumber, isObject, isSymbol } from '../is'
+export { getGlobalThis } from './global'
 
 type PropertyName = string | number | symbol
 type ObjectTarget = {

packages/utils/src/string/index.ts

@@ -0,0 +1,18 @@
+/*
+ * @Author: vyron
+ * @Date: 2022-06-01 16:03:12
+ * @LastEditTime: 2022-06-01 17:09:47
+ * @LastEditors: vyron
+ * @Description: string utils
+ * @FilePath: /utils/packages/utils/src/string/index.ts
+ */
+
+/**
+ * Converts the first character of a string to uppercase and returns the string
+ * @param {string} str - The string to convert
+ * @returns {string} - The converted string
+ */
+export function upperFirst(str: string): string {
+  if (!str) return str
+  return str.charAt(0).toUpperCase() + str.slice(1)
+}