npm 包 harvest-timesheets 使用教程

阅读时长 5 分钟读完

在前端开发中,时间记录是非常重要的任务。为了更加高效且精确地记录时间,我们可以使用 harvest-timesheets 这个 npm 包。本文将为大家详细介绍如何使用这个包来进行时间记录。

何为 harvest-timesheets

harvest-timesheets 是一款基于 Harvest API 的 npm 包。Harvest 是一个非常流行的在线时间跟踪工具,而 harvest-timesheets 就是一款使用 Harvest API 进行时间跟踪的 npm 包。

安装

我们可以通过以下命令来安装 harvest-timesheets:

使用

授权

在使用 harvest-timesheets 之前,我们需要进行授权。首先,我们需要创建一个新的 Harvest 应用程序。在 Harvest 的管理员面板中,创建一个新的应用程序,并将应用程序的 Client IDClient Secret 备份下来。接着,我们可以使用以下代码来进行授权:

-- -------------------- ---- -------
----- ------- - ------------------------------

----- ------- - --- ---------
    ---------- -----------------
    --------- -----------------
    ------------- ---------------------
---

------------------------------------------------- ---------------- -- -- -
    -- --------
---

在这个例子中,我们首先导入 harvest-timesheets 包 并创建了一个新的 Harvest 实例。我们使用 authenticateWithCredentials 方法对 Harvest 进行了授权。在这个方法中,我们需要传入 Harvest 用户账号的电子邮件和密码。当授权成功后,它会执行回调函数中的代码。

创建时间记录

在成功授权之后,我们可以开始创建时间记录。在 Harvest 中,时间记录代表一段时间,通常以小时为单位。我们可以使用以下代码来创建一个新的时间记录:

-- -------------------- ---- -------
-------------------------
    ----------- --------
    -------- --------
    ----------- -------------
    ------ --
    ------ -------
-- -- -- -
    -- ------------
---

在这个例子中,我们使用 timeRecords.add 方法来创建一个新的时间记录。在这个方法中,我们需要传入以下信息:

  • project_id:要记录时间的项目 ID;
  • task_id:记录时间的任务 ID;
  • spent_date:记录时间的日期;
  • hours:要记录的时间数量;
  • notes:记录时间的描述。

当时间记录成功创建之后,它会执行回调函数中的代码。

获取时间记录

在记录时间之后,我们可以使用以下代码来获取时间记录:

在这个例子中,我们使用 timeRecords.get 方法来获取记录的时间。在这个方法中,我们需要传入以下信息:

  • from:要检索的记录的起始日期;
  • to:要检索的记录的截止日期。

此外,我们还需要传入一个回调函数。当获取的时间记录被返回时,它会执行回调函数中的代码。在这个例子中,我们只是简单地将获取的记录打印到控制台上。

示例代码

下面是一个完整的示例代码:

-- -------------------- ---- -------
----- ------- - ------------------------------
----- ------- - --- ---------
    ---------- -----------------
    --------- -----------------
    ------------- ---------------------
---

------------------------------------------------- ---------------- -- -- -
    -------------------------
        ----------- --------
        -------- --------
        ----------- -------------
        ------ --
        ------ -------
    -- -- -- -
        -------------------------
            ----- -------------
            --- -------------
        -- --------- -- -
            ---------------------
        ---
    ---
---

总结

本文通过详细介绍 harvest-timesheets 的使用方法,让我们了解了如何更加高效地进行时间记录。我们希望这篇文章可以对你在前端开发中进行时间记录有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005517381e8991b448cebb1

纠错
反馈