zm-countdown
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Readme

简介

Countdown 类是一个简单的倒计时工具,用于在 TypeScript 项目中实现倒计时功能。

安装

通过 npm 或 yarn 安装:

npm install zm-countdown

yarn add zm-countdown

使用方法

  1. 导入 Countdown 类。
import Countdown from "zm-countdown";
  1. 创建 Countdown 实例,并传入倒计时时间和其他可选参数。
const countdown = new Countdown({
  countdown: 1000 * 60 * 60, // 设置倒计时时间为1小时
  finishedCallback: () => {
    console.log("倒计时结束");
  },
  tick: () => {
    console.log("剩余时间:", countdown.time);
  },
});
  1. 开始倒计时。
countdown.start();
  1. 暂停倒计时。
countdown.pause();
  1. 恢复倒计时。
countdown.resume();
  1. 结束倒计时。
countdown.end();
  1. 重置倒计时。
countdown.reset();
  1. 获取剩余时间。
console.log("剩余时间:", countdown.restTime);
  1. 获取倒计时状态。
console.log("倒计时状态:", countdown.state);
  1. 获取剩余时间信息。
console.log("剩余时间信息:", countdown.time);

以上是 Countdown 类的详细使用方法和示例,希望对你有所帮助。

Readme

Keywords

Package Sidebar

Install

npm i zm-countdown

Weekly Downloads

10

Version

1.0.0

License

none

Unpacked Size

10.2 kB

Total Files

5

Last publish

Collaborators

  • wzm-npm