@getclarify/nylas-mirror

中文文档
7.6.0发布于 2024/06/25MITTypeScriptESM + CJS近 30 天下载 1.1万

A mirror for a NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.

原始使用文档
文档目录9 节
  1. ⚙️ Install
  2. Set up using npm
  3. Build from source
  4. ⚡️ Usage
  5. 🚀 Making Your First Request
  6. 📚 Documentation
  7. ✨ Upgrading from 6.x
  8. 💙 Contributing
  9. 📝 License

An unofficial fork of the Nylas Node.js SDK that fixes timeout errors.

Aimeos logo

Nylas Node.js SDK

npm codecov

This is the GitHub repository for the Nylas Node SDK. This repo is primarily for anyone who wants to make contributions to the SDK, or install it from source. If you are looking to use Node to access the Nylas Email, Calendar, or Contacts API you should refer to our official Node SDK Quickstart Guide.

The Nylas Communications Platform provides REST APIs for Email, Calendar, and Contacts, and the Node SDK is the quickest way to build your integration using JavaScript.

Here are some resources to help you get started:

⚙️ Install

Note: The Nylas Node SDK requires Node.js v16 or later.

Set up using npm

To run the Nylas Node SDK, first install Node and npm on your machine.

Then, head to the nearest command line and run the following: npm install nylas

Alternatively, you can use Yarn to install the Nylas Node SDK by running the yarn add nylas command.

Build from source

To install this package from source, clone this repo and run npm install from inside the project directory.

git clone https://github.com/nylas/nylas-nodejs.git
cd nylas-nodejs
npm install

⚡️ Usage

To use this SDK, you must first get a free Nylas account.

Then, follow the Quickstart guide to set up your first app and get your API keys.

For code examples that demonstrate how to use this SDK, take a look at our Node repos in the Nylas Samples collection.

🚀 Making Your First Request

You access Nylas resources (messages, calendars, events, contacts) through an instance of Nylas. The Nylas object must be initialized with your Nylas API key, and you can provide other additional configurations such as the Nylas API url and the timeout.

import Nylas from "nylas";

const nylas = new Nylas({
  apiKey: "NYLAS_API_KEY",
});

Once initialized you can use the object to make requests for a given account's resources, for example to list all the calendars for a given account:

nylas.calendars.list({ identifier: "GRANT_ID" }).then(calendars => {
  console.log(calendars);
});

📚 Documentation

Nylas maintains a reference guide for the Node SDK to help you get familiar with the available methods and classes.

✨ Upgrading from 6.x

See UPGRADE.md for instructions on upgrading from 6.x to 7.x.

Note: The Node SDK v7.x is not compatible with the Nylas API earlier than v3-beta.

💙 Contributing

Please refer to Contributing for information about how to make contributions to this project. We welcome questions, bug reports, and pull requests.

📝 License

This project is licensed under the terms of the MIT license. Please refer to LICENSE for the full terms.

版本与发布记录

@getclarify/nylas-mirror 共发布 1 个版本,首次发布于 2024/06/25;过去 12 个月发布了 0 个版本。

版本发布日期距今
7.6.0latest2024/06/252 年前

关于 @getclarify/nylas-mirror 的常见问题

@getclarify/nylas-mirror 是什么?

A mirror for a NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.

如何安装 @getclarify/nylas-mirror?

在项目目录运行 npm install @getclarify/nylas-mirror,或使用 pnpm add / yarn add / bun add。

@getclarify/nylas-mirror 支持 TypeScript 吗?

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

@getclarify/nylas-mirror 支持 ESM 还是 CommonJS?

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

@getclarify/nylas-mirror 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=16。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@getclarify/nylas-mirror 可以商用吗?

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

@getclarify/nylas-mirror 的下载量有多少?

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

@getclarify/nylas-mirror 还在维护吗?

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