JSPM

dropbox

5.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 113147
  • Score
    100M100P100Q172867F
  • License MIT

The Dropbox JavaScript SDK is a lightweight, promise based interface to the Dropbox v2 API that works in both nodejs and browser environments.

Package Exports

  • dropbox
  • dropbox/dist/Dropbox-sdk.min

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dropbox) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Dropbox JavaScript SDK

Build Status npm version

The Dropbox JavaScript SDK is a lightweight, promise based interface to the Dropbox v2 API that works in both nodejs and browser environments. It provides common services for making API requests and helper utilities contributed by the community. This library depends on the Promise global which requires a polyfill (es6-promise) for unsupported browsers.

It also requires that fetch be passed into the constructor; we advise using the isomorphic-fetch library which supports fetch within both environments.

A Javascript SDK for integrating with the Dropbox API v2. Node v6+. Documentation is available on gh-pages.

Installation

Create an app at https://dropbox.com/developers/apps

Install via npm:

    $ npm install --save dropbox

Install from source:

    $ git clone git://github.com/dropbox/dropbox-sdk-js.git
    $ cd dropbox-sdk-js
    $ npm install

After installation, to get started, follow one of our examples or read the documentation on gh-pages.

Authentication

All requests need to be made with an OAuth 2 access token. To get started, once you've created an app, you can go to the app's console and generate an access token for your own Dropbox account for development. You can also find a variety of examples outlining different authorization flows under:

You can also view our OAuth guide

Example Applications

  • Javascript - A set sample applications that demonstrate various functionalities
  • Typescript - A set of sample applications the demonstrate various functionalities

Contributing

Contributions to this SDK are always welcome and encouraged!

See the CONTRIBUTING doc for more information

License

MIT - See the LICENSE for more information