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) ⇒ <code> Object </code>
反转对象的键和值。
类型:utils/core
的静态方法
返回值:Object
- 反转后的对象。
参见:https://ultimatecourses.com/blog/reverse-object-keys-and-values-in-javascript
参数 | 类型 | 描述 |
---|---|---|
data | Object | 要反转的对象。 |
utils/core.escapeRegExp(string) ⇒ <code> string </code>
通过将字符串中的正则表达式特殊字符替换为它们的转义对应物来转义它们。
类型:utils/core
的静态方法
返回值:string
- 转义后的字符串。
参数 | 类型 | 描述 |
---|---|---|
string | string | 要转义的字符串。 |
utils/core.isTypedArray(val) ⇒ <code> boolean </code>
检查值是否为类型化数组。
类型:utils/core
的静态方法
返回值:boolean
- 如果值是 TypedArray
,则为 true,否则为 false。
改编自 https://stackoverflow.com/a/71091338/13989043
参数 | 类型 | 描述 |
---|---|---|
val | * | 要检查的值。 |
utils/core.isIntegralNumber(x) ⇒ <code> boolean </code>
检查值是否为整数。
类型:utils/core
的静态方法
返回值:boolean
- 如果值是字符串,则为 true,否则为 false。
参数 | 类型 | 描述 |
---|---|---|
x | * | 要检查的值。 |
utils/core.isNullishDimension(x) ⇒ <code> boolean </code>
确定提供的宽度或高度是否为空值。
类型:utils/core
的静态方法
返回值:boolean
- 如果值为 null
、undefined
或 -1
,则为 true,否则为 false。
参数 | 类型 | 描述 |
---|---|---|
x | * | 要检查的值。 |
utils/core.calculateDimensions(arr) ⇒ <code> Array. < number > </code>
计算嵌套数组的维度。
类型:utils/core
的静态方法
返回值:Array.<number>
- 包含输入数组维度的数组。
参数 | 类型 | 描述 |
---|---|---|
arr | Array.<any> | 要计算维度的嵌套数组。 |
utils/core.pop(obj, key, defaultValue) ⇒ <code> * </code>
复制 python 的 .pop() 对象方法。
类型:utils/core
的静态方法
返回值:*
- 弹出的键的值。
抛出:
Error
如果键不存在且未提供默认值。
参数 | 类型 | 描述 |
---|---|---|
obj | Object | 要从中弹出的对象。 |
key | string | 要弹出的键。 |
defaultValue | * | 如果键不存在,则返回的默认值。 |
utils/core.mergeArrays(arrs) ⇒ <code> Array </code>
高效地合并数组,创建新副本。改编自 https://stackoverflow.com/a/6768642/13989043
类型:utils/core
的静态方法
返回值:Array
- 合并后的数组。
参数 | 类型 | 描述 |
---|---|---|
arrs | Array.<Array> | 要合并的数组。 |
utils/core.calculateReflectOffset(i, w) ⇒ <code> number </code>
计算给定索引和窗口大小的索引偏移量。
类型:utils/core
的静态方法
返回值:number
- 索引偏移量。
参数 | 类型 | 描述 |
---|---|---|
i | number | 索引。 |
w | number | 窗口大小。 |
utils/core.saveBlob(path, blob)
在 Web 上保存 blob 文件。
类型:utils/core
的静态方法
参数 | 类型 | 描述 |
---|---|---|
path | string | 保存 blob 的路径 |
blob | Blob | 要保存的 blob |
utils/core.pick(o, props) ⇒ <code> Object </code>
类型:utils/core
的静态方法
参数 | 类型 |
---|---|
o | Object |
props | Array.<string> |
utils/core.len(s) ⇒ <code> number </code>
计算字符串的长度,考虑多字节字符。这模仿了 Python 的 len
函数的行为。
类型:utils/core
的静态方法
返回值:number
- 字符串的长度。
参数 | 类型 | 描述 |
---|---|---|
s | string | 要计算长度的字符串。 |
utils/core.count(arr, value)
计算数组或字符串中值的出现次数。这模仿了 Python 的 count
方法的行为。
类型:utils/core
的静态方法
参数 | 类型 | 描述 |
---|---|---|
arr | Array<any> | string | 要搜索的数组或字符串。 |
value | any | 要计数的值。 |
utils/core~InitiateProgressInfo : <code> Object </code>
类型:utils/core
的内部类型定义
属性
名称 | 类型 | 描述 |
---|---|---|
status | 'initiate' | |
name | string | 模型 ID 或目录路径。 |
file | string | 文件名。 |
utils/core~DownloadProgressInfo : <code> Object </code>
类型:utils/core
的内部类型定义
属性
名称 | 类型 | 描述 |
---|---|---|
status | 'download' | |
name | string | 模型 ID 或目录路径。 |
file | string | 文件名。 |
utils/core~ProgressStatusInfo : <code> Object </code>
类型:utils/core
的内部类型定义
属性
名称 | 类型 | 描述 |
---|---|---|
status | 'progress' | |
name | string | 模型 ID 或目录路径。 |
file | string | 文件名。 |
progress | number | 介于 0 和 100 之间的数字。 |
loaded | number | 已加载的字节数。 |
total | number | 要加载的总字节数。 |
utils/core~DoneProgressInfo : <code> Object </code>
类型:utils/core
的内部类型定义
属性
名称 | 类型 | 描述 |
---|---|---|
status | 'done' | |
name | string | 模型 ID 或目录路径。 |
file | string | 文件名。 |
utils/core~ReadyProgressInfo : <code> Object </code>
类型:utils/core
的内部类型定义
属性
名称 | 类型 | 描述 |
---|---|---|
status | 'ready' | |
task | string | 加载的任务。 |
model | string | 加载的模型。 |
utils/core~ProgressInfo : <code> InitiateProgressInfo </code> | <code> DownloadProgressInfo </code> | <code> ProgressStatusInfo </code> | <code> DoneProgressInfo </code> | <code> ReadyProgressInfo </code>
类型:utils/core
的内部类型定义
utils/core~ProgressCallback ⇒ <code> void </code>
一个回调函数,当进度信息更新时会被调用。
类型:utils/core
的内部类型定义
参数 | 类型 |
---|---|
progressInfo | ProgressInfo |
< > 在 GitHub 上更新