nb.pubfn Public Function Library

import nb from '@/lib/function'

// Usage Examples
nb.pubfn.isNull(value)
nb.pubfn.timeFormat(new Date())
nb.pubfn.tree.arrayToTree(list)

nb.pubfn.timeFormat(date, format, targetTimezone)

nb.pubfn.timeFormat(new Date(), 'yyyy-MM-dd')
// "2025-12-03"

nb.pubfn.timeFormat(1733136000000, 'yyyy年MM月dd日 hh:mm')
// "2025年12月02日 18:00"

const info = nb.pubfn.getDateInfo(new Date())
// { year: 2025, month: 12, day: 3, hour: 10, minute: 30, second: 0, week: 3, quarter: 4 }

const time = nb.pubfn.getCommonTime()
// { todayStart, todayEnd, monthStart, monthEnd, yearStart, yearEnd, weekStart, weekEnd, now }

await nb.pubfn.sleep(1000)  // Wait 1 second

nb.pubfn.isNull(null)       // true
nb.pubfn.isNull('')         // true
nb.pubfn.isNull({})         // true
nb.pubfn.isNull([])         // true
nb.pubfn.isNull(0)          // false
nb.pubfn.isNotNull('hello') // true

nb.pubfn.isNullOne(a, b, c)     // At least one is null
nb.pubfn.isNullAll(a, b, c)     // All are null
nb.pubfn.isNotNullAll(a, b, c)  // All are not null

nb.pubfn.test('13800138000', 'mobile')  // true
nb.pubfn.test('[email protected]', 'email')  // true

nb.pubfn.isArray([1, 2, 3])      // true
nb.pubfn.isObject({ a: 1 })      // true
nb.pubfn.isString('hello')       // true
nb.pubfn.isNumber(123)           // true
nb.pubfn.isFunction(() => {})    // true
nb.pubfn.isDate(new Date())      // true

nb.pubfn.getType([])             // 'array'
nb.pubfn.getType({})             // 'object'
nb.pubfn.getType(null)           // 'null'

const newObj = nb.pubfn.deepClone(obj)

const obj = { a: { b: { c: 1 } } }

nb.pubfn.getData(obj, 'a.b.c')           // 1
nb.pubfn.getData(obj, 'a.b.d', 'default') // 'default'

nb.pubfn.setData(obj, 'a.b.c', 2)
nb.pubfn.setData(obj, 'x.y.z', 3)  // Auto-create path

const defaultData = { name: '', age: 0, enable: true }
const itemData = { name: 'John', age: 25 }

const formData = nb.pubfn.formAssign(defaultData, itemData)
// { name: 'John', age: 25, enable: true }

const obj = { id: 1, name: 'John', password: '123' }

nb.pubfn.getNewObject(obj, ['id', 'name'])  // { id: 1, name: 'John' }
nb.pubfn.deleteObjectKeys(obj, ['password']) // { id: 1, name: 'John' }

const list = [
  { id: 1, name: 'John' },
  { id: 2, name: 'Jane' }
]

nb.pubfn.getListItem(list, 'id', 2)  // { id: 2, name: 'Jane' }
nb.pubfn.getListIndex(list, 'id', 2) // 1

const list = [
  { id: 'a', name: 'John' },
  { id: 'b', name: 'Jane' }
]

nb.pubfn.arrayToJson(list, 'id')
// { a: { id: 'a', name: 'John' }, b: { id: 'b', name: 'Jane' } }

nb.pubfn.arrayObjectGetArray(list, 'id')  // ['a', 'b']

nb.pubfn.arrayUnique([1, 2, 2, 3])  // [1, 2, 3]
nb.pubfn.arrayUnique([{id:1},{id:2},{id:1}], 'id')  // [{id:1},{id:2}]

nb.pubfn.arraySort([3, 1, 2])  // [1, 2, 3]
nb.pubfn.arraySort([{age:30},{age:20}], 'age', 'desc')  // [{age:30},{age:20}]

nb.pubfn.arrayDiff([1,2,3], [2,3,4])       // [1] (difference)
nb.pubfn.arrayIntersect([1,2,3], [2,3,4])  // [2,3] (intersection)
nb.pubfn.arrayUnion([1,2,3], [2,3,4])      // [1,2,3,4] (union)

const list = [
  {type:'a', v:1},
  {type:'b', v:2},
  {type:'a', v:3}
]
nb.pubfn.groupBy(list, 'type')
// { a: [{type:'a',v:1},{type:'a',v:3}], b: [{type:'b',v:2}] }

nb.pubfn.sum([1, 2, 3])       // 6
nb.pubfn.average([1, 2, 3])   // 2
nb.pubfn.max([1, 2, 3])       // 3
nb.pubfn.min([1, 2,3])       // 1

nb.pubfn.sum([{v:1},{v:2}], 'v')  // 3

nb.pubfn.shuffle([1, 2, 3, 4, 5])      // Random shuffle
nb.pubfn.sample([1, 2, 3, 4, 5])       // Random pick one
nb.pubfn.sampleSize([1, 2, 3, 4, 5], 3) // Random pick 3

nb.pubfn.tree.arrayToTree(arr, options)

const list = [
  { id: 1, parentId: null, name: 'System Management' },
  { id: 2, parentId: 1, name: 'User Management' },
  { id: 3, parentId: 1, name: 'Role Management' },
]

const tree = nb.pubfn.tree.arrayToTree(list, {
  filter: (item) => item.enable !== false,
  sortBy: [{ field: 'sort', order: 'asc' }]
})

nb.pubfn.tree.treeToArray(tree, { addLevel: true })
// [{ id: 1, name: 'A', level: 0 }, { id: 2, name: 'B', level: 1 }, ...]

const selectTree = nb.pubfn.tree.mapTree(menuTree, (node) => ({
  title: node.name,
  value: node.id,
  key: node.id,
}))

const node = nb.pubfn.tree.findInTree(tree, (item) => item.id === 'menu-1')

const filtered = nb.pubfn.tree.filterTree(tree, (item) => 
  item.name.includes('User')
)

const leaves = nb.pubfn.tree.getLeaves(tree)

nb.pubfn.hidden('13800138000', 3, 4)  // '138****8000'

nb.pubfn.random(6)                // '123456' (numbers only)
nb.pubfn.random(8, 'a-z,0-9')     // 'a1b2c3d4'
nb.pubfn.random(10, 'a-z,A-Z,0-9') // 'aB1cD2eF3g'

nb.pubfn.trim('  hello  ')         // 'hello'
nb.pubfn.truncate('hello world', 8) // 'hello...'

nb.pubfn.capitalize('hello')    // 'Hello'
nb.pubfn.uncapitalize('Hello')  // 'hello'

nb.pubfn.uuid()       // 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
nb.pubfn.shortUuid()  // 'a1b2c3d4' (8 characters)

nb.pubfn.encodeBase64('hello')     // 'aGVsbG8='
nb.pubfn.decodeBase64('aGVsbG8=')  // 'hello'

nb.pubfn.parseJSON('{"a":1}')      // { a: 1 }
nb.pubfn.parseJSON('invalid', {})  // {} (returns default value on parse failure)

nb.pubfn.formatMoney(1234567.89)     // '1,234,567.89'
nb.pubfn.formatMoney(1234567.89, 0)  // '1,234,568'

nb.pubfn.priceFilter(100)   // '1.00'
nb.pubfn.priceFilter(1234)  // '12.34'

nb.pubfn.toDecimal(1.56555, 2)  // 1.57

nb.pubfn.debounce(() => {
  // Execute search
}, 300)

nb.pubfn.throttle(() => {
  // Execute operation
}, 1000)

const tasks = [
  () => fetch('/api/1'),
  () => fetch('/api/2'),
]
const results = await nb.pubfn.batchRun(tasks, 2)  // Max 2 concurrent

// ✅ Recommended
if (nb.pubfn.isArray(value)) { }
if (nb.pubfn.isNull(data)) { }

// ❌ Not Recommended
if (Array.isArray(value)) { }
if (!data || data === '') { }

// ✅ Recommended
const tree = nb.pubfn.tree.arrayToTree(list)
const node = nb.pubfn.tree.findInTree(tree, predicate)

// ❌ Not Recommended: Manual recursion
function buildTree(list, parentId = null) { ... }

// ✅ Recommended
const id = nb.pubfn.uuid()

// ❌ Not Recommended
import { v4 as uuidv4 } from 'uuid'