@art-suite/art-core-ts-async

中文文档
1.0.1发布于 2026/06/19MITTypeScriptESM + CJS近 30 天下载 3216

类型脚本的同步与承诺工具

中文使用文档
文档目录6 节
  1. 为什么是这个模块?
  2. 安装和使用示例( 需要)
  3. 职能概览
  4. timeout(ms: number, f?: () => unknown): Promise<unknown>
  5. timeoutAt(triggerAtTime: AllDateTypes, f?: () => unknown): …
  6. API 文档参考

@art-site/art-core-ts-s-sync (中文(简体) )

TypeScript 的基本同步工具, 包括强壮的“ 承诺” 超时助手 .

为什么是这个模块?

它使常见的协同操作更加简洁,更清晰,更不易出错,同时为遗留的API提供现代的、基于承诺的替代品,如: setTimeout。这个模块帮助您用一个简单,类型安全的API来写更可读和可维护的ASync代码.

  • 超时 : 创建一个在指定延迟后解决的保证, 在超时后可选择运行一个函数 .
  • 超时 : 创建一个在特定时间(日期、时间戳或日期字符串)解决的许诺,在超时后可选择运行一个函数.

安装和使用示例( 需要)

用 npm 安装 :

npm install @art-suite/art-core-ts-async

基本用途:

import { timeout, timeoutAt } from "@art-suite/art-core-ts-async";

// Wait for 500ms
await timeout(500);

// Wait for 1 second, then run a function
await timeout(1000, () => console.log("done"));

// Wait until a specific time (e.g., 2 seconds from now)
await timeoutAt(Date.now() + 2000);

// Wait until a specific time, then run a function
await timeoutAt(new Date(Date.now() + 1000), () => "finished"); // resolves to "finished"

职能概览

timeout(ms: number, f?: () => unknown): Promise<unknown>

创建一个在指定数毫秒后解决的许诺。 可以选择的是,一个函数可以在超时后被调用. 如果是这样,承诺将随着职能的结果而解决.

  • timeout(1000) 1秒后解决
  • timeout(500, () => "done") + 500ms后用价值解决 "done"

timeoutAt(triggerAtTime: AllDateTypes, f?: () => unknown): Promise<unknown>

创建一个在特定时间解决的承诺。 时间可以是日期,数字(秒或毫秒),也可以是日期-时间字符串. 可以选择的是,一个函数可以在超时后被调用. 如果是这样,承诺将随着职能的结果而解决.

  • timeoutAt(Date.now() + 1000) 1秒后解决
  • timeoutAt(new Date(Date.now() + 500), () => 42) + 500ms后用价值解决 42

API 文档参考

关于所有被输出功能及其参数的详细信息,请参见源代码内的TypeScript打字和JSDoc评论.

版本与发布记录

@art-suite/art-core-ts-async 共发布 15 个版本,首次发布于 2025/06/17;过去 12 个月发布了 6 个版本。

版本发布日期距今
1.0.1latest2026/06/194 个月前
1.0.02026/03/297 个月前
0.3.02026/03/277 个月前
0.2.112025/12/0511 个月前
0.2.102025/12/0511 个月前
0.2.92025/12/0411 个月前

关于 @art-suite/art-core-ts-async 的常见问题

@art-suite/art-core-ts-async 是什么?

类型脚本的同步与承诺工具

如何安装 @art-suite/art-core-ts-async?

在项目目录运行 npm install @art-suite/art-core-ts-async,或使用 pnpm add / yarn add / bun add。

@art-suite/art-core-ts-async 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@art-suite/art-core-ts-async 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@art-suite/art-core-ts-async 可以商用吗?

@art-suite/art-core-ts-async 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@art-suite/art-core-ts-async 的下载量有多少?

根据 npm 官方下载统计,@art-suite/art-core-ts-async 在 2026/10/07 – 2026/11/05 这 30 天内被下载 3,216 次,日均约 107 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@art-suite/art-core-ts-async 还在维护吗?

最新版本 1.0.1 发布于 2026/06/19(4 个月前);至今共发布 15 个版本,其中过去 12 个月发布了 6 个;首次发布于 2025/06/17。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。