utils package
Classes
Class | Description |
---|---|
DB | (BETA) 这是一个类,用于简单创建和访问 IndexedDB 数据库中的储存对象。 每一个 DB 实例都只对应一个存储对象(object store)。 |
EventsController | (BETA) DOM Event Controller |
MathRange | (BETA) 数字区间类,构造一个形如 (4, 10] 的区间对象,区分开闭区间。 |
Vec2 | (BETA) 二维向量类 |
Functions
Function | Description |
---|---|
add_keyboard_events(type, eventsOptions) | 该函数添加带有选项的键盘事件,并提供关闭、关闭/打开和手动触发事件的方法。 |
arr_move(arr, from, to) | 函数 arr_move 将数组中的元素从一个索引移动到另一个索引。 |
arr_random(arr) | 该函数从数组中返回一个随机元素。 |
arr_remove(arr, value) | 函数 arr_remove 用于从数组中删除指定的值。 |
arr_to_obj(arr, v) | 该函数将数组转换为一个对象,其中键作为属性和一个可选的默认值。 |
arr_unique(arr) | 此函数接受任何类型的数组并返回一个仅包含唯一值的新数组。 |
arr_value_index(arr) | 这个 TypeScript 函数接受一个键数组并返回一个对象,每个键的值是它在数组中的索引。 |
blob_to_date_URI(blob) | 此函数将 Blob 对象转换为数据 URI 字符串或 ArrayBuffer。 |
bytes_to_int(bytes) | 该函数将四个字节的数组转换为单个整数值。 |
canvas_to_blob(cvs) | 此函数将 HTML canvas 元素转换为 Blob 对象并返回一个 Promise。 |
canvas_to_image(cvs, quality) | 此函数将画布元素转换为具有指定质量的图像元素。 |
clone_deep(source) | 这是一个执行对象深度克隆的函数。 |
clone_simple(source) | 该函数使用 JSON 解析和字符串化克隆一个简单对象。 |
clone(source) | 该函数使用简单方法或深层方法克隆对象,具体取决于简单方法是否失败。 |
copy_text(target, addition) | 该函数使用剪贴板 API(如果可用)将文本复制到剪贴板,否则它回退到创建临时文本区域元素并使用 execCommand 方法。 |
data_URI_to_blob(dataURI, mimeType) | 此函数将数据 URI 转换为 blob 对象。 |
date_now(format) | 该函数以指定格式返回当前日期和时间。 |
debounce(func, timeFrame) | 为给定函数实现去抖动功能。 |
deep_equal(a, b) | 该函数检查两个对象或数组是否相等。 |
dom_get_css(el, prop) | 该函数返回给定 DOM 元素的指定 CSS 属性的值。 |
dom_get_el(selector) | 该函数根据给定的选择器字符串返回 DOM 元素,如果选择器无效或未找到该元素,则返回未定义的元素。 |
dom_get_size(el) | 该函数返回 DOM 元素或窗口的大小。 |
dom_set_css_var(varName, value, el) | 这个函数在给定的 DOM 元素上设置一个 CSS 变量。 |
dom_set_css(el, css) | 该函数在给定的 HTML 元素上设置 CSS 样式。 |
download_blob(blob, fileName) | 该函数将 Blob 对象下载为具有给定文件名或生成的 UUID 的文件。 |
download_by_url(URL, fileName) | 此函数使用可选文件名从给定的 URL 下载文件。 |
download_canvas(cvs, imageName) | 此函数将画布元素下载为具有默认名称或指定名称的 PNG 图像。 |
download_image(img, imageName) | 该函数通过其 URL 下载图像并使用生成或提供的名称保存它。 |
get_contrast_color(color) | 该函数将颜色作为输入,并根据输入颜色的亮度返回黑色或白色作为对比色。 |
get_fill_arr(length, value) | 该函数创建一个指定长度的数组,其中填充了指定的值。 |
get_lightness_value(color) | 该函数以 RGB 或十六进制格式计算颜色的亮度值。 |
hex_to_rgb(hex) | 该函数将十六进制颜色代码转换为其对应的 RGB 颜色值。 |
hsl_to_rgb(hsl) | 该函数将 HSL 格式的颜色转换为 RGB 格式。 |
image_get_type(filename) | 该函数根据文件扩展名返回图像文件的 MIME 类型。 |
image_mini(img, quality) | 该函数接受一个 HTML 图像元素和一个质量参数,调整图像大小并返回一个包含调整后图像的新图像元素。 |
image_resize(img, options) | 此函数根据指定的选项调整 HTML 图像元素的大小,并将调整后的图像作为新的 HTML 图像元素返回。 |
image_to_blob(img) | 此函数使用画布将 HTML 图像元素转换为 blob 对象。 |
image_to_canvas(img, size) | 此函数将 HTML 图像元素转换为具有指定大小的画布元素。 |
image_to_data_URI(img, type) | 此函数将 HTML 图像元素转换为数据 URI。 |
int_to_bytes(num) | 该函数使用按位运算将整数转换为 4 字节的数组并返回该数组。 |
is_base64(str) | 该函数检查给定字符串是否是具有可选数据 URI 方案的有效 base64 编码字符串。 |
is_blob(blob) | 该函数检查给定对象是否是 Blob 类的实例。 |
is_callable(target) | 判断给定的参数是否是函数 |
is_chinese(str) | 该函数检查给定字符串是否全是汉字,范围为 [0x4e00, 0x9fa5]。 |
is_date(d) | 该函数检查给定值是否为 TypeScript 中的 Date 对象。 |
is_element(el) | 该函数检查给定对象是否是 TypeScript 中 Element 类的实例。 |
is_email(str) | 函数正在检查给定的字符串是否是有效的电子邮件地址。它使用正则表达式将字符串与有效电子邮件地址的模式进行匹配。 如果字符串与模式匹配,则函数返回“true”,表明它是有效的电子邮件地址。否则,它返回“false”。 |
is_empty_array(v, nullable) | 该函数检查给定值是否为空数组或 null/undefined。 |
is_empty_obj(v, nullable) | 检查给定值是否为空对象。 |
is_empty_string(s, trim) | 该函数检查给定字符串是否为空,并使用可选参数在检查前修剪字符串。 |
is_file(file) | 该函数检查给定对象是否是 File 类的实例。 |
is_fn(fn) | 该函数检查给定变量是否为函数。 |
is_hex_color(color) | 该函数检查给定的字符串是否是有效的十六进制颜色代码。 |
is_html_element(hel) | 该函数检查给定变量是否是 HTMLElement 类的实例。 |
is_not_empty_string(s, trim) | 该函数检查给定的输入是否为非空字符串或非空值。 |
is_not_void(t) | 该函数检查值是否不为 undefined 或 null。 |
is_null(n) | 该函数检查给定值是否为空。 |
is_number(n) | 该函数检查给定值是否为有限数。 |
is_object(o) | 该函数检查给定值是否是对象而不是数组。 |
is_regexp(r) | 该函数检查给定值是否为正则表达式。 |
is_rgb_color(color) | 该函数检查给定颜色是否为 RGB 颜色。 |
is_string_like(target) | 该函数检查给定目标是字符串还是数字。 |
is_undefined(u) | 该函数检查给定值是否未定义。 |
is_void(t) | 该函数检查给定值是否为 null 或 undefined,或者它是否为 NaN 的数字。 |
is_window_or_element(el) | 该函数检查给定对象是否是元素或window。 |
is_window(win) | 该函数检查给定参数是否是 TypeScript 中的全局窗口对象。 |
key_in(key, obj) | 该函数检查给定对象中是否存在给定键并返回布尔值。 |
log_type_error(type, name) | 该函数使用预期的类型和名称记录类型错误消息。 |
match_range(n, pattern) | (BETA) 对数字进行模式匹配 |
math_between(v, min, max) | 该函数返回指定范围内的数字。 |
math_random_int(from, to) | 该函数返回指定范围内的随机整数。 |
math_to_fixed(n, digit) | 该函数返回一个四舍五入到指定小数位数的数字。 |
math_to_hex(n) | 该函数将数字转换为包含大写字母且最小长度为 2 个字符的十六进制字符串。 |
object_concat(target, source) | 函数 object_concat 连接两个通用类型的对象并返回连接后的对象。 |
object_entries(obj) | 此函数将对象的条目作为键值对数组返回。 |
object_keys(o) | 该函数将对象的键作为数组返回。 |
object_pick(obj, keys) | 函数“object_pick”接受一个对象和一个键数组,并返回一个新对象,该对象仅包含原始对象中的指定键。 |
point_in_polygon(point, polygon) | 函数“point_in_polygon”使用光线投射算法确定点是否在多边形内部。 |
rgb_to_hex(rgb) | 该函数将 RGB 颜色数组转换为十六进制颜色代码。 |
rgb_to_hsl(rgb) | 该函数将 RGB 颜色值转换为其对应的 HSL 颜色值。 |
search_range(n, ranges) | (BETA) 在数字区间列表中搜索数字所处的区间 |
storage_get(key, empty) | 该函数从本地存储中检索数据并将其作为已解析的 JSON 对象或可选的默认值返回。 |
storage_remove(key) | 该函数根据给定的键从本地存储中删除一个项目。 |
storage_set(key, value) | 该函数使用指定的键将任何类型的值存储在浏览器的本地存储中。 |
str_capital_all(str) | 该函数将给定字符串中每个单词的首字母大写。 |
str_capital(str) | 该函数将给定字符串的第一个字母大写。 |
str_complement(n, len, char) | 该函数将前导零添加到数字或字符串中以使其具有特定长度。 |
str_ensure_chinese(str) | 函数从输入字符串中删除所有非中文字符。 |
str_ensure_prefix(s, prefix) | 该函数确保给定的字符串具有指定的前缀。 |
str_ensure_suffix(s, suffix) | 该函数确保给定的字符串以指定的后缀结尾。 |
str_maybe_number(target) | 该函数接受一个数字或字符串并将其作为字符串返回。 |
str_no_prefix(s, prefix) | 该函数从字符串中删除给定的前缀(如果存在)。 |
str_no_suffix(s, suffix) | 该函数从字符串中删除给定的后缀(如果存在)。 |
str_random(count, radix) | 该函数生成指定长度和基数的随机字符串。 |
str_uuid() | 生成 UUID 字符串。 |
temp_compiler(temp, data) | 该函数接受一个字符串模板和一个数据对象,并返回一个已解析的字符串,其中包含插入到模板中的数据值。 |
throttle(func, timeFrame, immediately) | 为给定函数实现节流功能。 |
throw_type_error(type, name) | 该函数抛出带有特定消息的 TypeError。 |
url_to_blob(url) | 此函数将 URL 作为输入并返回一个 Promise,该 Promise 解析为包含来自 URL 的数据的 Blob 对象。 |
url_to_date_URI(url, type) | 此函数将 URL 转换为图像的数据 URI。 |