Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@nozbe/teams-api

Nozbe1MIT0.1.0

Official Nozbe Teams API wrapper for Node.js

nozbe, nozbe-teams, todo, task-management

readme

@nozbe/teams-api

A npm package to connect with Nozbe Teams ✅

MIT License npm

What is @nozbe/teams-api?

@nozbe/teams-api is a way to interact with your Nozbe Teams account.

It allows you to create utilities for Nozbe Teams, list your projects, manage your tasks and comment on them. For now - It is continuosly developed to give you more possibilities.

⚠️ Note this package is still a WIP and the API may change (even if we do what we can to avoid that).

Installation

npm install @nozbe/teams-api

or

yarn add @nozbe/teams-api

Usage

Quick (over-simplified) example: adding the task to your Single tasks

To interact with Nozbe Teams you need to grab an API token from Settings -> Integrations.

First, you create a Nozbe Teams client:

import NozbeTeams from "@nozbe/teams-api";

const nozbeClient = new NozbeTeams("fakeApiToken123456");

Then, you can add a new task:

await client.addTask("Build a brand new app for Nozbe Teams!");

Simple as that.

You can find the basic API reference here.

Contributing

We need you

@nozbe/teams-api is an open-source project and it needs your help to thrive!

If there's a missing feature, a bug, or other improvement you'd like, we encourage you to contribute! Feel free to open an issue to get some guidance.

If you make or are considering making an app using @nozbe/teams-api, please let us know!

Authors and license

@nozbe/teams-api was created by @Nozbe. Main author is Krystian Kościelniak.

@nozbe/teams-api is available under the MIT license. See the LICENSE file for more info.

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.1.0

Added

  • This CHANGELOG file
  • The apiClient abstraction to simplify the code
  • Updating the Task
  • Improved error messages

0.0.2

Fixed

  • Fix the issue with using the package in Node.js

0.0.1

  • Initial release of @nozbe/teams-api