dayjs

• 类型：Dayjs

dayjs 函数。

definedFlags

• 类型：enums.EFlag[]

预定义的 Flag 列表。

destructors

• 类型：(() => void)[]

在页面重载前执行的析构函数列表。

inputBinds

• 类型：Dict<() => void>

包含所有自定义输入绑定的字典。

addInputBinds(binds)

• 参数：
  • binds: Dict<() => void>：函数字典，键为需要响应的输入字符串，值为被执行的事件函数。
• 返回值：无

增加自定义输入绑定。

chopStr(str, sep, trim?, last?)

• 参数：
  • str: string：任意字符串。
  • sep: string：分隔符。
  • trim = true：是否移除分隔符两边的空白字符。
  • last = false：是否倒序查找分隔符。
• 返回值：[string, string | null]

用指定分隔符将字符串切成两半。

sleep(timeout)

• 参数：
  • timeout: number：毫秒数。
• 返回值：Promise<void>

等待指定的毫秒数。

trimList(list, distinct?)

• 参数：
  • list: string[]：字符串列表。
  • distinct = true：是否去重。
• 返回值：string[]

移除列表项前后的空白字符和空列表项。

addCacheKey(path, needClean?)

• 参数：
  • path: string：文件路径。
  • needClean = true：是否需要清除文件路径中的 URL 前缀。
• 返回值：string

为指定文件路径添加缓存键。

addCustomTag(href, reside, isScript)

• 参数：
  • href: string：链接地址。
  • reside: boolean：是否在页面重载时保留元素。
  • isScript: boolean：是自定义脚本还是自定义样式。
• 返回值：boolean

将指定链接地址添加为自定义脚本 / 自定义样式。如果已经存在相同链接，则返回 false。

stringifyAny(value)

• 参数：
  • value: any：任意类型值。
• 返回值：string

将任意类型值转换为字符串。

isolatedEval(str)

• 参数：
  • str: string：字符串代码。
• 返回值：any

一个隔离上下文环境的 eval。

evalFunction(evalStr, params, asyncResults?)

• 参数：
  • evalStr: string：字符串代码。
  • params: Dict<any>：用于包裹字符串代码的函数的参数字典。
  • asyncResults?: TAsyncResult[]：异步行内脚本的执行结果列表。
• 返回值：[string, boolean]

将指定字符串包裹进如下闭包函数执行：

eval(`(function(${Object.keys(params).join()}){${evalStr}})`)(...Object.values(params));

返回执行结果和是否遇到异常。如果遇到异常，返回结果为异常信息。

replaceByRegExp(regexp, data, callback)

• 参数：
  • regexp: RegExp：正则表达式。
  • data: string：需要进行替换的字符串。
  • callback: (match: RegExpExecArray) => string：接收正则表达式执行结果列表的回调函数，返回替换值。
• 返回值：string

替换正则表达式匹配到的值。

用法：

vno.utils.replaceByRegExp(vno.regexp.getParamRegExp(), '{{ 0 }}llo Wo{{ 1 }}', ([, match]) => {
  return ['He', 'rld'][parseInt(match)];});

waitFor(callback, maxCount?, timeout?)

• 参数：
  • callback: () => T：回调函数。
  • maxCount = 100：最大重试次数。
  • timeout = 100：失败后等待的毫秒数。
• 返回值：Promise<T | undefined>

重复执行回调函数，直到无异常抛出或达到重试次数的上限，返回回调函数的返回值或 undefined。

waitForEvent(callback, event, element?)

• 参数：
  • callback: () => T：回调函数。
  • event: enums.EEvent：事件类型。
  • element: Document | Element = document：添加事件监听器的元素。
• 返回值：Promise<T>

等待指定事件被派发给指定元素后再执行回调函数，返回回调函数的返回值。

addEventListener(element, type, listener)

• 参数：
  • element: Document | Element：添加事件监听器的元素。
  • type: string：事件类型。
  • listener: EventListenerOrEventListenerObject：监听器函数。
• 返回值：无

为元素添加事件监听器。它同时也会将移除监听器的函数 push 进 vno.utils.destructors。

callAndListen(callback, event, element?, reside?)

• 参数：
  • callback: () => void：回调函数。
  • event: enums.EEvent：事件类型。
  • element: Document | Element = document：添加事件监听器的元素。
  • reside = false：是否在页面重载时保留监听器。
• 返回值：无

执行回调函数，并将它作为事件监听器添加到指定元素。

encodeParam(value)

• 参数：
  • value: string：参数值。
• 返回值：string

基本等同于 encodeURIComponent，只不过额外转义了单引号。可以用于在嵌入链接中编码嵌入参数。

getMessage(key, params?)

• 参数：
  • key: string：索引键，可以深入对象（a.b.c）或列表（a.0.c）。
  • params?: TMessage：需要嵌入的参数列表或字典。如果列表长度为 1，可以直接传入列表项。
• 返回值：string

根据索引键从当前配置对象的 messages 段取出对应的字符串，支持使用嵌入参数语法占位。

parseDate(date)

• 参数：
  • date: string | number：日期字符串或时间戳。
• 返回值：Date

解析日期字符串或时间戳为 Date 对象。

formatDate(date, format?)

• 参数：
  • date: string | number | Date | Dayjs：日期字符串、时间戳、Date 对象、Dayjs 对象。
  • format?: string：日期格式化字符串。
• 返回值：string

格式化日期。

This page is open source, improve it