Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 5.02 KB

README.md

File metadata and controls

100 lines (65 loc) · 5.02 KB

Eventbrite JavaScript SDK

version downloads module formats: esm, cjs, & umd npm type definitions semantic-release

PRs Welcome license

Maintenance Status Build Status Dependencies status Dev Dependencies status

code style: prettier

Watch on GitHub Star on GitHub Tweet

The official JavaScript SDK for the Eventbrite v3 API.

NOTE: This library is still in beta as we flesh out the API of the SDK.

Table of Contents

Installation

Install via Yarn:

yarn add eventbrite

Install via NPM:

npm install --save eventbrite

Quick Usage

const eventbrite = require('eventbrite');

// Create configured Eventbrite SDK
const sdk = eventbrite({token: 'OATH_TOKEN_HERE'});

// See: https://www.eventbrite.com/developer/v3/endpoints/users/#ebapi-get-users-id
sdk.request('/users/me').then(res => {
    // handle response data
});

Read more on getting a token.

API Docs

Eventbrite v3 API JavaScript SDK Documentation

Target Environments

The SDK works in both the browser and Node environments. As a result, we provide multiple build targets for you to consume depending on your environment:

Libraries

  • ESM - (EMCAScript modules) Everything transpiled to ES5 except for ES2015 import/export statements enabling tree shaking
  • CJS - (CommonJS) Standard format for most bundling systems including Node fully transpiled to ES5
  • UMD - (Universal module definition) Combination of EJS & AMD (asynchronous module definition) fully transpiled to ES5

Bundled distributions

If you don't have or cannot use a module system in your web app, the bundle distributions come as a single file with all of the dependencies included:

Contributing

Contributions are welcome! See Contributing Guidelines for more details.

Project philosophy

We take the stability of this SDK very seriously. eventbrite follows the SemVer standard for versioning.

All updates must pass the CI build.

License

The library is available as open source under the terms of the MIT License.