JavaScript
Clone or download
Latest commit 73656c5 Aug 9, 2018
Permalink
Failed to load latest commit information.
docs Release 3.19.1 Aug 9, 2018
examples Merge branch 'master' of https://github.com/twilio/node-private into … May 12, 2017
lib [Librarian] Regenerated @ e337be13bc02c074a1c656e2fc59a42e0972e381 Aug 9, 2018
spec [Librarian] Regenerated @ e337be13bc02c074a1c656e2fc59a42e0972e381 Aug 9, 2018
.gitignore .jscs to .jscsrc to match convention Mar 31, 2017
.jscsrc .jscs to .jscsrc to match convention Mar 31, 2017
.jshintignore Merge branch 'next-gen' of https://github.com/twilio/twilio-node into… Apr 13, 2017
.jshintrc Address jshint errors Mar 29, 2017
.npmignore The same changes that were made in the .gitignore file were applied t… Oct 28, 2014
.travis.yml Remove old Precise env and sudo flag (#362) Jul 6, 2018
CHANGES.md [Librarian] Regenerated @ e337be13bc02c074a1c656e2fc59a42e0972e381 Aug 9, 2018
CONTRIBUTING.md Adding Beta and Preview products to main artifact Jul 27, 2017
Dockerfile Add Dockerfile and related changes to build the Docker image (#358) Jul 5, 2018
ISSUE_TEMPLATE.md [Librarian] Regenerated @ 61e059e9694883693c4919778c1e37947fdb3168 Jul 27, 2017
LICENSE.md [Librarian] Regenerated @ a4cb3dcc12627f0ab0fcc6104a6bed708e9375c4 Jan 22, 2018
Makefile Tag and push Docker latest image when deploying with TravisCI (#366) Jul 31, 2018
README.md Add Dockerfile and related changes to build the Docker image (#358) Jul 5, 2018
UPGRADE.md Regenerate mainline library for signal May 22, 2017
VERSIONS.md [Librarian] Regenerated @ 61e059e9694883693c4919778c1e37947fdb3168 Jul 27, 2017
index.js first step toward 0.5 Dec 10, 2012
package-lock.json Add a request body validator (#365) Jul 12, 2018
package.json Release 3.19.1 Aug 9, 2018

README.md

twilio-node

A node.js Twilio helper library.

NPM

Build Status

Supported versions

This library works with node versions 6, 8 and above.

Unreleased Features

Some Twilio features that are exposed in this library are in Beta or Developer Preview, and are not available to most accounts. Such products are explicitly documented as Beta/Developer Preview both in the Twilio docs and console, as well as through in-line code documentation here in the library.

End User Docs

For detailed usage information and API docs, head out here:

https://www.twilio.com/docs/libraries/node

Docker Image

The Dockerfile present in this repository and its respective twilio/twilio-node Docker image are currently used by Twilio for testing purposes only.

Getting help

If you need help installing or using the library, please contact Twilio Support at help@twilio.com first. Twilio's Support staff are well-versed in all of the Twilio Helper Libraries, and usually reply within 24 hours.

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

Contributing

Bug fixes, docs and library improvements are always welcome.

⚠️ Please be aware that a large share of the files are auto-generated by our backend tool. You are welcome to suggest changes and submit PRs illustrating the changes. However, we'll have to make the changes in the underlying tool. You can find more info about this in the Contributing Guide

If you're not familiar with the GitHub pull request/contribution process, this is a nice tutorial.

Getting Started

If you want to familiarize yourself with the project, you can start by forking the repository and cloning it in your local development environment. The project requires Node.js to be installed on your machine.

After cloning the repository, install the dependencies by running the following command in the directory of your cloned repository:

npm install

You can run the existing tests to see if everything is okay by executing:

npm test

To run just one specific test file instead of the whole suite, provide a JavaScript regular expression that will match your spec file's name, like:

npm run test -- -m .\*client.\*

Contributing Code

Please refer to our Contributing Guide for detailed information on how you can contribute.

Contributing Docs

Right now, the docs are maintained in static HTML in the gh-pages branch of this repository. We hope to switch to a more robust documentation system soon, but for the time being, you can make documentation changes by editing index.html directly.