https://github.com/mieky/trello-fetcher

Promise-based wrapper for easy Trello API calls
https://github.com/mieky/trello-fetcher

api convenience helper minimal promise request trello wrapper

Last synced: about 1 month ago
JSON representation

Promise-based wrapper for easy Trello API calls

• Host: GitHub
• URL: https://github.com/mieky/trello-fetcher
• Owner: mieky
• License: mit
• Created: 2017-02-04T14:30:12.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-18T18:06:11.000Z (over 7 years ago)
• Last Synced: 2024-04-24T21:00:45.836Z (7 months ago)
• Topics: api, convenience, helper, minimal, promise, request, trello, wrapper
• Language: JavaScript
• Size: 18.6 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# trello-fetcher

[![npm version](https://badge.fury.io/js/trello-fetcher.svg)](http://badge.fury.io/js/trello-fetcher) [![Build Status](https://travis-ci.org/mieky/trello-fetcher.svg?branch=master)](https://travis-ci.org/mieky/trello-fetcher)

A minimal Promise-based wrapper for easy Trello API calls.

Uses [node-fetch](https://github.com/bitinn/node-fetch) for effortless manipulation of requests.

Install with:

```js

npm install --save trello-fetcher

```

Requires **Node 4.0** or newer.

## Usage

Require and create an instance with your Trello key and API token:

```js

const TrelloFetcher = require("trello-fetcher");

const fetchTrelloURL = new TrelloFetcher({

    key: "my_secret_trello_key",

    token: "my_secret_trello_token"

});

```

After this, you're ready to start firing Trello API calls by using the very URLs in the [Trello API documentation](https://developers.trello.com/advanced-reference).

### Examples

You should be able to do pretty much all the operations listed in the Trello API, by specifying the method and possible some query arguments.

Get cards in list:

```js

fetchTrelloURL(`lists/53280b9c3a5a1241b8318206/cards`)

    .then(cards => {

        console.log(`Got ${cards.length} cards:`);

        console.log(`${JSON.stringify(cards, null, 2)}`);

    })

    .catch(err => {

        console.error(`Bork! ${err.message}`);

    });

```

Set a card name:

```js

fetchTrelloURL(`cards/${card.id}/name`, {

    method: "PUT",

    queryArgs: {

        value: card.name

    }

});

```

Set card position:

```js

fetchTrelloURL(`cards/${card.id}/pos`, {

    method: "PUT",

    queryArgs: {

        value: "bottom"

    }

});

```

## Changelog

- **0.2.0** Add support for Node 4.

- **0.1.0** First release.

## Acknowledgments

[![chilicorn](chilicorn.png)](http://futurice.com/blog/sponsoring-free-time-open-source-activities)

## License

[MIT](https://github.com/mieky/trello-fetcher/blob/master/LICENSE)