Transformers.js 文档
utils/core
并获得增强的文档体验
开始使用
utils/core
Transformers.js 的核心实用函数/类。
这些只在内部使用,这意味着最终用户不应该需要访问这里的任何东西。
- utils/core
- 静态
.reverseDictionary(data)
⇒Object
.escapeRegExp(string)
⇒string
.isTypedArray(val)
⇒boolean
.isIntegralNumber(x)
⇒boolean
.isNullishDimension(x)
⇒boolean
.calculateDimensions(arr)
⇒Array.<number>
.pop(obj, key, defaultValue)
⇒*
.mergeArrays(arrs)
⇒Array
.calculateReflectOffset(i, w)
⇒number
.saveBlob(path, blob)
.pick(o, props)
⇒Object
.len(s)
⇒number
.count(arr, value)
- 内部
~InitiateProgressInfo
:Object
~DownloadProgressInfo
:Object
~ProgressStatusInfo
:Object
~DoneProgressInfo
:Object
~ReadyProgressInfo
:Object
~ProgressInfo
:InitiateProgressInfo
|DownloadProgressInfo
|ProgressStatusInfo
|DoneProgressInfo
|ReadyProgressInfo
~ProgressCallback
⇒void
- 静态
utils/core.reverseDictionary(data) ⇒ Object
反转对象的键和值。
类型:utils/core
的静态方法
返回:Object
- 反转后的对象。
参考:https://ultimatecourses.com/blog/reverse-object-keys-and-values-in-javascript
参数量 | 类型 | 描述 |
---|---|---|
数据 | 对象 | 要反转的对象。 |
utils/core.escapeRegExp(string) ⇒ string
通过将正则表达式中的特殊字符替换为转义后的对应字符,来转义字符串中的正则表达式特殊字符。
类型:utils/core
的静态方法
返回:string
- 转义后的字符串。
参数量 | 类型 | 描述 |
---|---|---|
字符串 | 字符串 | 要转义的字符串。 |
utils/core.isTypedArray(val) ⇒ boolean
检查值是否为类型化数组。
类型:utils/core
的静态方法
返回:boolean
- 如果值为 TypedArray
则为 true,否则为 false。
改编自 https://stackoverflow.com/a/71091338/13989043
参数量 | 类型 | 描述 |
---|---|---|
值 | * | 要检查的值。 |
utils/core.isIntegralNumber(x) ⇒ boolean
检查值是否为整数。
类型:utils/core
的静态方法
返回:boolean
- 如果值为字符串则为 true,否则为 false。
参数量 | 类型 | 描述 |
---|---|---|
x | * | 要检查的值。 |
utils/core.isNullishDimension(x) ⇒ boolean
确定所提供的宽度或高度是否为空值。
类型:utils/core
的静态方法
返回:boolean
- 如果值为 null
、undefined
或 -1
,则为 true,否则为 false。
参数量 | 类型 | 描述 |
---|---|---|
x | * | 要检查的值。 |
utils/core.calculateDimensions(arr) ⇒ Array.<number>
计算嵌套数组的维度。
类型:utils/core
的静态方法
返回:Array.<number>
- 包含输入数组维度的数组。
参数量 | 类型 | 描述 |
---|---|---|
arr | Array.<any> | 要计算维度的嵌套数组。 |
utils/core.pop(obj, key, defaultValue) ⇒ *
复制 Python 的 .pop() 对象方法。
类型:utils/core
的静态方法
返回:*
- 弹出键的值。
抛出:
Error
如果键不存在且未提供默认值。
参数量 | 类型 | 描述 |
---|---|---|
obj | 对象 | 要弹出的对象。 |
键 | 字符串 | 要弹出的键。 |
defaultValue | * | 如果键不存在,则返回的默认值。 |
utils/core.mergeArrays(arrs) ⇒ Array
高效合并数组,创建新副本。改编自 https://stackoverflow.com/a/6768642/13989043
类型:utils/core
的静态方法
返回:Array
- 合并后的数组。
参数量 | 类型 | 描述 |
---|---|---|
arrs | Array.<Array> | 要合并的数组。 |
utils/core.calculateReflectOffset(i, w) ⇒ number
计算给定索引和窗口大小的索引偏移量。
类型:utils/core
的静态方法
返回:number
- 索引偏移量。
参数量 | 类型 | 描述 |
---|---|---|
i | 数字 | 索引。 |
w | 数字 | 窗口大小。 |
utils/core.saveBlob(path, blob)
在 web 上保存 blob 文件。
类型:utils/core
的静态方法
参数量 | 类型 | 描述 |
---|---|---|
路径 | 字符串 | 保存 blob 的路径。 |
blob | Blob | 要保存的 blob。 |
utils/core.pick(o, props) ⇒ Object
类型:utils/core
的静态方法
参数量 | 类型 |
---|---|
o | 对象 |
属性 | Array.<string> |
utils/core.len(s) ⇒ number
计算字符串的长度,考虑到多字节字符。这模仿了 Python 的 len
函数的行为。
类型:utils/core
的静态方法
返回:number
- 字符串的长度。
参数量 | 类型 | 描述 |
---|---|---|
s | 字符串 | 要计算长度的字符串。 |
utils/core.count(arr, value)
计算值在数组或字符串中出现的次数。这模仿了 Python 的 count
方法的行为。
类型:utils/core
的静态方法
参数量 | 类型 | 描述 |
---|---|---|
arr | Array<any> | string | 要搜索的数组或字符串。 |
值 | 任何 | 要计数的数值。 |
utils/core~InitiateProgressInfo : Object
类型:utils/core
的内部类型定义
属性
名称 | 类型 | 描述 |
---|---|---|
状态 | 'initiate' | |
名称 | 字符串 | 模型 ID 或目录路径。 |
文件 | 字符串 | 文件名。 |
utils/core~DownloadProgressInfo : Object
类型:utils/core
的内部类型定义
属性
名称 | 类型 | 描述 |
---|---|---|
状态 | 'download' | |
名称 | 字符串 | 模型 ID 或目录路径。 |
文件 | 字符串 | 文件名。 |
utils/core~ProgressStatusInfo : Object
类型:utils/core
的内部类型定义
属性
名称 | 类型 | 描述 |
---|---|---|
状态 | 'progress' | |
名称 | 字符串 | 模型 ID 或目录路径。 |
文件 | 字符串 | 文件名。 |
进度 | 数字 | 一个介于 0 到 100 之间的数字。 |
已加载 | 数字 | 已加载的字节数。 |
总计 | 数字 | 要加载的总字节数。 |
utils/core~DoneProgressInfo : Object
类型:utils/core
的内部类型定义
属性
名称 | 类型 | 描述 |
---|---|---|
状态 | 'done' | |
名称 | 字符串 | 模型 ID 或目录路径。 |
文件 | 字符串 | 文件名。 |
utils/core~ReadyProgressInfo : Object
类型:utils/core
的内部类型定义
属性
名称 | 类型 | 描述 |
---|---|---|
状态 | 'ready' | |
任务 | 字符串 | 已加载的任务。 |
模型 | 字符串 | 已加载的模型。 |
utils/core~ProgressInfo : InitiateProgressInfo
| DownloadProgressInfo
| ProgressStatusInfo
| DoneProgressInfo
| ReadyProgressInfo
类型:utils/core
的内部类型定义
utils/core~ProgressCallback ⇒ void
一个回调函数,用于接收进度信息。
类型:utils/core
的内部类型定义
参数量 | 类型 |
---|---|
进度信息 | 进度信息 |
< > 在 GitHub 上更新