杂项

timer

计时器，用来返回两次调用之间的耗时

typescript

import { timer } from "flex-tools";

timer.begin();
await doing();
timer.end(); // time consuming: 12ms

timer.end("耗时："); // 耗时：12ms
timer.end("耗时：", { unit: "s" }); // 耗时：1200s

说明

timer.begin和timer.end必须成对出现

允许嵌套使用timer.begin和timer.end

typescript

    timer.begin() -------------|
    await doing()              |
        timer.begin() ---      |
        await doing()    |     |
        timer.end()   ---      |
    timer.end()  --------------|

parseTimeDuration

解析如1ms, 12s , 98m, 100h,12Hours,8Days, 6Weeks, 8Years, 1Minute的字符串为毫秒数。

typescript

// ms
parseTimeDuration("1"); // =1
parseTimeDuration("1ms"); // =1
parseTimeDuration("1Milliseconds"); // =1
//s
parseTimeDuration("1s"); // =1000
parseTimeDuration("1Seconds"); // =1000
parseTimeDuration("1.5s"); // =1500
parseTimeDuration("1.5Seconds"); // =1500

// m
parseTimeDuration("1m"); // =60000
parseTimeDuration("1Minutes"); // =60000
parseTimeDuration("1.5m"); // =60000+60000*0.5
parseTimeDuration("1.5Minutes"); // =60000+60000*0.5
// h
parseTimeDuration("1h"); // =3600000
parseTimeDuration("1Hours"); // =3600000
parseTimeDuration("1.5h"); // =3600000+3600000*0.5
parseTimeDuration("1.5Hours"); // =3600000+3600000*0.5

// D
parseTimeDuration("1D"); // =86400000
parseTimeDuration("1d"); // =86400000
parseTimeDuration("1Days"); // =86400000
parseTimeDuration("1.5d"); // =86400000+86400000*0.5
parseTimeDuration("1.5Days"); // =86400000+86400000*0.5

// W
parseTimeDuration("1w"); // =604800000
parseTimeDuration("1W"); // =604800000
parseTimeDuration("1Weeks"); // =604800000
parseTimeDuration("1.5w"); // =604800000+604800000*0.5
parseTimeDuration("1.5Weeks"); // =604800000+604800000*0.5

// M
parseTimeDuration("1M"); // =2592000000
parseTimeDuration("1Months"); // =2592000000
parseTimeDuration("1.5M"); // =2592000000+2592000000*0.5
parseTimeDuration("1.5Months"); // =2592000000+2592000000*0.5

// Y
parseTimeDuration("1Y"); // =31104000000
parseTimeDuration("1y"); // =31104000000
parseTimeDuration("1Years"); // =31104000000
parseTimeDuration("1.5Y"); // =31104000000+31104000000*0.5
parseTimeDuration("1.5Years"); // =31104000000+31104000000*0.5

parseFileSize

解析如1ms, 12s , 98m, 100h,12Hours,8Days, 6Weeks, 8Years, 1Minute的字符串为字节数。

typescript

parseFileSize(1); //1,无单位代表是字节
parseFileSize("33b"); //33
parseFileSize("33B"); //33
parseFileSize("33Byte"); //33
//kb
parseFileSize("1k"); //1024
parseFileSize("1K"); //1024
parseFileSize("1kb"); //1024
parseFileSize("1KB"); //1024

parseFileSize(".5k"); //512
parseFileSize("0.5k"); //512)
parseFileSize("1.5k"); //1536
parseFileSize("1.5K"); //1536
parseFileSize("1.5kb"); //1536
parseFileSize("1.5KB"); //1536

//mb
parseFileSize("1m"); //1048576
parseFileSize("1M"); //1048576
parseFileSize("1mb"); //1048576
parseFileSize("1MB"); //1048576

parseFileSize("1.5m"); //1572864
parseFileSize("1.5M"); //1572864
parseFileSize("1.5mb"); //1572864
parseFileSize("1.5MB"); //1572864

//gb
parseFileSize("1g"); //1073741824
parseFileSize("1g"); //1073741824
parseFileSize("1gb"); //1073741824
parseFileSize("1GB"); //1073741824

parseFileSize("1.5g"); //1610612736
parseFileSize("1.5G"); //1610612736
parseFileSize("1.5gb"); //1610612736
parseFileSize("1.5GB"); //1610612736

formatDateTime

简单的日期时间格式化函数，格式化模板字符兼容dayjs。在某些场合如果要对时间日期进行格式化，就可以不再需要引入完整的dayjs了。

typescript

function formatDateTime(value?: Date | number, format?: string, options?: FormatDateTimeOptions);

expect(formatDateTime(new Date(2021, 3, 8, 6, 8, 12, 24), "yyyy-MM-DD HH:mm:ss.SSS")).toBe(
    "2021-04-08 06:08:12.024",
);

relativeTime

返回相对时间友好描述。

typescript

function relativeTime(
    value: Date | number,
    baseTime?: Date | number,
    options?: RelativeTimeOptions,
);

let now = Date.now();
relativeTime(now, now); // 刚刚
relativeTime(now - 500, now); // 刚刚
relativeTime(now - 1000, now); // 1秒前
relativeTime(now - 1000 * 60, now); // 1分钟前
relativeTime(now - 1000 * 60 * 60, now); // 1小时前
relativeTime(now - 1000 * 60 * 60 * 24, now); // 1天前
relativeTime(now - 1000 * 60 * 60 * 24 * 13, now); // 1周前
relativeTime(now - 1000 * 60 * 60 * 24 * 30, now); // 1个月前
relativeTime(now - 1000 * 60 * 60 * 24 * 30 * 3, now); // 3个月前
relativeTime(now - 1000 * 60 * 60 * 24 * 365, now); // 1年前
relativeTime(now + 1000, now); // 1秒后
relativeTime(now + 1000 * 60, now); // 1分钟后
relativeTime(now + 1000 * 60 * 60, now); // 1小时后
relativeTime(now + 1000 * 60 * 60 * 24, now); // 1天后
relativeTime(now + 1000 * 60 * 60 * 24 * 30, now); // 1个月后
relativeTime(now + 1000 * 60 * 60 * 24 * 30 * 12, now); // 12个月后
relativeTime(now + 1000 * 60 * 60 * 24 * 365, now); // 1年后

baseTime 用于计算相对时间的基准时间，默认为当前时间。
value参数可以是Date对象或者时间戳。
options参数可以指定units,now,before,after的参数。
- units默认等于["秒","分钟","小时","天","周","个月","年"]，如果是英文环境则可以更改为["second","minute","hour","day","week","month","year"]。
- now默认等于刚刚，如果是英文环境则可以更改为Just now。
- before默认等于{value}{unit}前，可以自定义显示方式。
- after默认等于{value}{unit}后，可以自定义显示方式。

execScript

执行脚本命令并返回输出字符串

typescript

interface ExecScriptOptions {
    silent?: boolean; // 静默输出,即控制台输出不会显示
    env?: NodeJS.ProcessEnv;
    maxBuffer?: number;
    encoding?: string;
}
async function execScript(script: string, options?: ExecScriptOptions);

await execScript("npm info");
const output = await execScript("npm info", { silent: true }); // 控制台不显示

switchValue

对输入的值进行匹配，如果匹配相同则返回对应的值

typescript


class User{
    name="a"
}

const switcher = {
    1:"I am 1",
    current:"current",
    parent:"parent",
    String:"I am string",
    Number:()=>"I am number",   // 如果是函数则会执行函数取返回值
    Function:()=>{ return "I am function" },
    Object:"I am object",
    Array:"I am array",
    Boolean:"I am boolean",
    StringArray:"I am string array",
    NumberArray:"I am number array",
    BooleanArray:"I am boolean array"
}

    switchValue(1,switcher))                // == "I am 1"
    switchValue("current",switcher))        // == "current"
    switchValue("parent",switcher))         // == "parent"
    switchValue("xxxxx",switcher))          // ==  I am string
    switchValue(100,switcher))              // ==  I am number
    switchValue(true,switcher))             // ==  I am boolean
    switchValue({},switcher))               // ==  I am object
    switchValue([],switcher))               // ==  I am array
    switchValue(["String"],switcher))       // ==  I am string array
    switchValue([100],switcher))            // ==  I am number array
    switchValue([true],switcher))           // ==  I am boolean array
    switchValue(()=>{},switcher))           // ==  I am function
    switchValue(Symbol(),switcher,{defaultValue:1}))  // == 1
    switchValue(new User(),{
            User: "I am user"
        },{
            typeMatchers:{
                User: (value:any)=> value instanceof User
            }
        }
    ))  // == "I am user"

支持两个参数,defaultValue用于指定默认值，如果没有指定则返回undefined。typeMatchers用于自定义类型匹配器，如果没有指定则使用默认的类型匹配器。
内置Function、Object、Array、Boolean、String、Number、StringArray、NumberArray、BooleanArray类型匹配器,如果只是简单的类型判断，可以直接使用内置的类型匹配器。
也可以自定义类型匹配器，比如User类型，可以自定义类型匹配器User: (value:any)=> value instanceof User，这样就可以匹配User类型了。

getDynamicValue

获取动态值。

typescript

getDynamicValue(1); // 1
getDynamicValue(() => 1); // 1
getDynamicValue(async () => 1); // 1
getDynamicValue(async (n) => n + 1, { args: [1] }); // 2

escapeRegExp

此函数接收一个字符串，并将其中所有正则表达式的特殊字符（如 -、[、]、/、{、}、(、)、*、+、?、.、\、^、$、| 等）转义为其字面量形式，以便该字符串可以安全地用作正则表达式模式的一部分。

示例：

typescript

escapeRegExp("hello.world"); // `hello\.world`
escapeRegExp("[abc]+"); // `\[abc\]\+`
escapeRegExp("$5.00"); // `\$5\.00`

encodeRegExp

将正则表达式转换为字符串，并可选地用提供的变量替换占位符。

const regexStr1 = encodeRegExp(/hello/);
console.log(regexStr1);
// Output: "hello"

const regexStr2 = encodeRegExp(/hello__NAME__/, { __NAME__: "world" });
console.log(regexStr2);
// Output: "helloworld"

const regexStr3 = encodeRegExp(/foo\.__var1__\.__var2__/, { __var1__: "bar", __var2__: "baz" });
console.log(regexStr3);
// Output: "foo\\.bar\\.baz"

callProfiler

一般情况下，性能调优需要使用火焰图，可能会使用Clinic、Chrome DevTools、pref_hooks等等专业工具，但这些专业工具比较使用起来比较不方便，太专业了。 callProfiler提供一种轻量的测量方案，用于测量一段代码执行链中每个函数的调用时间，用于性能调优。

快速入门

使用方式如下：

class UserService {
    A1() {
        this._simulateWork("A1");
        this.A11();
        this.A12();
    }
    A2() {
        this._simulateWork("A2");
        this.A21();
    }

    // 第二层方法（被 A1 调用）
    A11() {
        this._simulateWork("A11");
        this.A111();
        this.A112();
    }

    A12() {
        this._simulateWork("A12");
    }

    // 第二层方法（被 A2 调用）
    A21() {
        this._simulateWork("A21");
    }

    // 第三层方法（被 A11 调用）
    A111() {
        this._simulateWork("A111");
    }

    A112() {
        this._simulateWork("A112");
    }
    _simulateWork(_name: string) {
        let sum = 0;
        for (let i = 0; i < 5000; i++) {
            sum += i;
        }
    }
}

我们要测量UserService.A1方法执行性能报告。

import { CallProfiler } from "flex-tools/misc/callProfiler";
const user = new UserService();
const profiler = new CallProfiler(user); 
await profiler.run(() => {
    user.A1(); 
});

调用profiler.run执行代码后，然后通过profiler.render渲染出一个执行调用的树，并且显示每一个函数执行耗时。如下：

console.log(profiler.render())[!code++];
// 输出如下：
// └── A1 (0.39ms)
//     ├── A2 (0.20ms)
//     │   ├── A11 (0.03ms)
//     │   └── A12 (0.04ms)
//     └── A3 (0.12ms)
//         └── A21 (0.03ms)

说明

CallProfiler原理很简单，就是扫描输入的对象的所有方法(或指定方法)，然后进行包装，包装逻辑对原方法的执行时间进行计时，最后输出报告。
CallProfiler可以对一个或多个对象的方法进行包装，以便进行计时。

// 封装指定对象的所有方法
const profiler = new CallProfiler(user);
// 封装指定多个对象的所有方法
const profiler = new CallProfiler([user,post]);
// 只对指定方法进行包装
const profiler = new CallProfiler(user,["method1",...,"method2"]);
// 对多个对象的多个方法进行包装
const profiler = new CallProfiler([
    [ user,["method1",...,"method2"]],
    [ post,["methodA",...,"methodB"]],
    address,
]);

测量结果支持profiler.report和profiler.render两种形式输出。profiler.report输出的是一个JSON格式的树，profiler.render输出用于终端显示的树。
profiler.attach和profiler.detach方法用于启用或禁用对象函数包装。默认情况下，new CallProfiler(...)时会自动执行attach。

杂项 ​

timer ​

parseTimeDuration ​

parseFileSize ​

formatDateTime ​

relativeTime ​

execScript ​

switchValue ​

getDynamicValue ​

escapeRegExp ​

encodeRegExp ​

callProfiler ​

杂项

timer

parseTimeDuration

parseFileSize

formatDateTime

relativeTime

execScript

switchValue

getDynamicValue

escapeRegExp

encodeRegExp

callProfiler