3.0.4 • Published 3 years ago

lopo-lib v3.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

lopo-lib

Installation

npm install lopo-lib
yarn add lopo-lib

Docs

clone 克隆

lib | test

  • declaration
function clone_deep<T>(obj: T, cache?: WeakMap<object, object>): T {
    /** inner code */
}

function clone_json<T>(obj: T): T {
    /** inner code */
}
  • example
const do_test_json = () => {
    const obj_json = {
        name: 'obj json',
        age: 11,
        greet: (who: string) => {
            return `hello ${ who }!`
        },
        symbol: Symbol('symbol as value'),
        [Symbol('symbol as key')]: 'symbol as key'
    }

    console.log(clone_json(obj_json))
}

const do_test_deep = () => {
    const obj_deep = {
        name: 'obj deep',
        age: 12,
        big: 456n,
        greet: (who: string) => {
            return `hello ${ who }!`
        },
        symbol: Symbol('symbol as value'),
        [Symbol('symbol as key')]: 'symbol as key'
    }

    console.log(clone_deep(obj_deep))
}

do_test_json()
// {
//   name: 'obj json',
//   age: 11
// }

do_test_deep()
// {
//   name: 'obj deep',
//   age: 12,
//   big: 456n,
//   greet: [Function (anonymous)],
//   symbol: Symbol(symbol as value),
//   [Symbol(symbol as key)]: 'symbol as key'
// }

debounce 防抖

lib | test

  • declaration
function debounce<Args>(fn: (...args: Args) => void, min_hold: number): (...args: Args) => void {
    /** inner code */
}
  • example
const do_test = () => {
    // 使用debounce包裹目标函数
    const logger = debounce((trigger: number) => {
        console.log('function in debounce, now in trigger ', trigger)
    }, 1000)

    let trigger_count = 0

    // 使用interval模拟频繁抖动
    const timer = setInterval(() => {
        console.log('now in trigger ', trigger_count)
        logger(trigger_count)
        if(trigger_count++ > 4) clearInterval(timer)
    }, 500)
}

do_test()
// now in trigger  0
// now in trigger  1
// now in trigger  2
// now in trigger  3
// now in trigger  4
// now in trigger  5
// function in debounce, now in trigger  5

eventBus 事件管理

lib | test

  • declaration
class EventBus<EventMap extends { [k: string]: (...args: any[]) => void }> {
    constructor() {
        /** inner code */
    }

    on<EvName extends keyof EventMap>(eventName: EvName, fn: EventMap[EvName]): void {
        /** inner code */
    }

    off<EvName extends keyof EventMap>(eventName: EvName, fn?: EventMap[EvName]): void {
        /** inner code */
    }

    emit<EvName extends keyof EventMap>(eventName: EvName, args: Parameters<EventMap[EvName]>): void {
        /** inner code */
    }

    dispose(): void {
        /** inner code */
    }
}
  • example
// 添加事件类型定义 (可选)
type SomeEvents = {
// 带参回调
    greet: (who: string) => void
// 无参回调
    sayHi: () => void
}
// 事件回调
const greet = (who: string) => {
    console.log(`hello, ${ who }!`)
}
const sayHi = () => {
    console.log('hi')
}

const evBus = new EventBus<SomeEvents>()

// 注册事件
evBus.on('greet', greet)
evBus.on('sayHi', sayHi)

// 触发事件
evBus.emit('greet', [ 'lopo' ])  // hello, lopo!
evBus.emit('sayHi', [])  // hi

// 注销事件
evBus.off('sayHi')

// 触发事件
evBus.emit('greet', [ 'lopo' ])  // hello, lopo!
evBus.emit('sayHi', [])  // nothing happen

frameTask 逐帧任务

仅web端可用, 使用了requestAnimationFrame

lib

  • declaration
class FrameTask {
    constructor(fps: number = 60) {
        /** inner code */
    }

    addTask<Task extends (...args: any[]) => void>(taskName: string, fn: Task, args: Parameters<Task>, immediate: boolean = false): void {
        /** inner code */
    }

    runTask(taskName: string): void {
        /** inner code */
    }

    pauseTask(taskName: string): void {
        /** inner code */
    }

    cancelTask_single(taskName: string): void {
        /** inner code */
    }

    cancelTask_with_expect(expect: string[]): void {
        /** inner code */
    }

    cancelTask_all(): void {
        /** inner code */
    }

    getState_name_list(): void {
        /** inner code */
    }

    getState_run(taskName: string): boolean | null {
        /** inner code */
    }

    getState_run_list(): void {
        /** inner code */
    }

    dispose(): void {
        /** inner code */
    }
}
  • example
const taskManager = new FrameTask(2)  // set fps to 0.5 (run task every 0.5s)

let globalCount = 1
const logger = () => {
    console.log('currnet: ', globalCount++)
}

taskManager.addTask('log', logger, [], true)

setTimeout(() => {
    taskManager.pauseTask('log')
}, 3000)

// the output will be like:
// currnet:  1
// currnet:  2
// currnet:  3
// currnet:  4
// currnet:  5
// currnet:  6

heap 堆

lib | test

  • declaration
// 大根堆
class Heap_big_root {
    get heap(): number[] {
        /** inner code */
    }

    get size(): number {
        /** inner code */
    }

    get max(): number {
        /** inner code */
    }

    constructor(nums: number[], depth: number = Infinity) {
        /** inner code */
    }

    add(val: number) {
        /** inner code */
    }

    delete(): number {
        /** inner code */
    }
}

// 小根堆
class Heap_small_root {
    get heap(): number[] {
        /** inner code */
    }

    get size(): number {
        /** inner code */
    }

    get min(): number {
        /** inner code */
    }

    constructor(nums: number[], depth: number = Infinity) {
        /** inner code */
    }

    add(val: number) {
        /** inner code */
    }

    delete(): number {
        /** inner code */
    }
}
  • example
const do_test_big = () => {
    const big_root = new Heap_big_root([ 2, 5, 1, 3, 6, 1, 2 ])
    big_root.add(5)
    console.log(big_root.heap)
    let head = big_root.delete()
    console.log(head, big_root.heap)
    head = big_root.delete()
    console.log(head, big_root.heap)
}
do_test_big()
// [ 6, 5, 3, 5, 2, 1, 1, 2 ]
// 6 [ 5, 5, 3, 2, 2, 1, 1 ]
// 5 [ 5, 2, 3, 2, 1, 1 ]

const do_test_small = () => {
    const small_root = new Heap_small_root([ 2, 5, 1, 3, 6, 1, 2 ])
    small_root.add(5)
    console.log(small_root.heap)
    let head = small_root.delete()
    console.log(head, small_root.heap)
    head = small_root.delete()
    console.log(head, small_root.heap)
}
do_test_small()
// [ 1, 1, 2, 2, 3, 5, 6, 5 ]
// 1 [ 1, 2, 2, 5, 3, 5, 6 ]
// 1 [ 2, 2, 6, 5, 3, 5 ]

prime 素数

lib | test

  • declaration
class Prime {
    /**
     * @description 返回 [2, n] 范围内的素数数量
     * @description 构造函数中的 list 参数传 true 可用; 否则始终返回 0
     */
    get primeCount(): number {
        /** inner code */
    }

    /**
     * @description 返回 [2, n] 范围内的所有素数
     * @description 构造函数中的 list 参数传 true 可用; 否则始终返回空数组 []
     */
    get primeList(): number {
        /** inner code */
    }

    /**
     * @description range [2, n]
     * @param n
     * @param map 是否埃氏筛生成哈希表
     * @param list 是否欧拉筛生成素数列表
     */
    constructor(n: number, map: boolean = true, list: boolean = true) {
        /** inner code */
    }

    /**
     * @description 返回 n 是否是素数
     * @description 若 n小于2或大于构造函数传入的最大值, 则抛出错误
     * @param n 待判断的数字
     */
    is(n: number): boolean {
        /** inner code */
    }
}
  • example
const do_test_wrong = () => {
    try {
        const wrong_when_double_false = new Prime(10, false, false)
    }
    catch (e: any) {
        console.log('error1: ', e.toString())
    }

    try {
        const wrong_when_n_out_range = new Prime(1)
    }
    catch (e: any) {
        console.log('error2: ', e.toString())
    }
}

const do_test_correct = () => {
    const primeFinder = new Prime(20)

    console.log('is 5 prime: ', primeFinder.is(5))
    console.log('is 16 prime: ', primeFinder.is(16))
    console.log('how many prime number in range [1, 20]: ', primeFinder.primeCount)
    console.log('show all the prime number in range [1, 20]: ', primeFinder.primeList)
}

do_test_wrong()
// error1:  Error: the instance is nonsense because both [map] and [list] are set to false
// error2:  Error: require n in range [2, 2^31]

do_test_correct()
// is 5 prime:  true
// is 16 prime:  false
// how many prime number in range [1, 20]:  8
// show all the prime number in range [1, 20]:  [
//    2,  3,  5,  7,
//   11, 13, 17, 19
// ]

promiseLike 类promise

lib | test

  • declaration
class PromiseLike<Result, Reason> {
    constructor(executor: (resolve: resolveFn<Result>, reject?: rejectFn<Reason>) => void) {
        /** inner code */
    }

    then(onFulFilled: resolveFn<Result>, onRejected?: rejectFn<Reason>): PromiseLike {
        /** inner code */
    }
}
  • example
const do_test = () => {
    const p1 = () => new PromiseLike((resolve, reject) => {
        setTimeout(() => {
            resolve(1)
        }, 1000)
    })

    const p2 = () => new PromiseLike((resolve, reject) => {
        setTimeout(() => {
            resolve(2)
        }, 1000)
    })

    p1().then((res1) => {
        console.log(Date.now(), ': res1: ', res1)
        return p2()
    }).then((res2) => {
        console.log(Date.now(), ': res2: ', res2)
    })
}

do_test()
// 1651827350110 : res1:  1
// 1651827351118 : res2:  2

randInRange 范围随机数

lib | test

  • declaration
function randInRange(left: number, right: number, exclude: "left" | "right" | "both" = 'right', step: number = 0): number {
    /** inner code */
}
  • example
// default [0, 1)
console.log(randInRange(0, 1))

// same as default [0, 1)
console.log(randInRange(0, 1, 'right'))

// (0, 1]
console.log(randInRange(0, 1, 'left'))

// random in [0.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9]
console.log(randInRange(0, 1, 'right', 0.1))

// random in [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0]
console.log(randInRange(0, 1, 'left', 0.1))

rangeMapping 区间映射

lib | test

  • declaration
// with 2 overload
function rangeMapping(from: [ number, number ], to: [ number, number ]): (val: number) => number
function rangeMapping(from: [ number, number ], to: [ number, number ], val: number): number
function rangeMapping(from: [ number, number ], to: [ number, number ], val?: number): ((val: number) => number) | number {
    /** inner code */
}
  • example
// overload 1
const mapping = rangeMapping([ 0, 1 ], [ 0, 100 ])

console.log(mapping(0))  // 0
console.log(mapping(0.5))  // 50
console.log(mapping(0.3))  // 30
console.log(mapping(1.1))  // 110.00000000000001

// overload 2
console.log(rangeMapping([ 0, 1 ], [ 0, 100 ], 0))  // 0
console.log(rangeMapping([ 0, 1 ], [ 0, 100 ], 0.5))  // 50
console.log(rangeMapping([ 0, 1 ], [ 0, 100 ], 0.3))  // 30
console.log(rangeMapping([ 0, 1 ], [ 0, 100 ], 1.1))  // 110.00000000000001

// anyway, `110.00000000000001` is not totally wrong.
// because in javascript, you will get this return for `1.1 * 100`.

throttle 节流

lib | test

  • declaration
function throttle<Args>(fn: (...args: Args) => void, min_gap: number): (...args: Args) => void {
    /** inner code */
}
  • example
const do_test = () => {
    // 使用throttle包裹目标函数
    const logger = throttle((trigger: number) => {
        console.log('function in throttle, now in trigger ', trigger)
    }, 1000)

    let trigger_count = 0

    // 使用interval模拟频繁调用
    const timer = setInterval(() => {
        console.log('now in trigger ', trigger_count)
        logger(trigger_count)
        if(trigger_count++ > 4) clearInterval(timer)
    }, 500)
}

do_test()
// now in trigger  0
// now in trigger  1
// function in throttle, now in trigger  1
// now in trigger  2
// now in trigger  3
// function in throttle, now in trigger  3
// now in trigger  4
// now in trigger  5
// function in throttle, now in trigger  5
lopocommonly-used-function
uuid
@infinitebrahmanuniverse/nolb-lop@zalastax/nolb-lop
3.0.4

3 years ago

3.0.3

3 years ago

3.0.2

3 years ago

3.0.1

3 years ago

2.0.2

3 years ago

2.0.2-alpha

3 years ago

2.0.2-fixed

3 years ago

2.0.1

3 years ago

1.1.2

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.0

4 years ago