Patreon / patreon-js

Use the Patreon API via OAuth.
MIT License
151 stars 30 forks source link

patreonOAuth not a function | incorrect documentation? #38

Open Vilksian opened 3 years ago

Vilksian commented 3 years ago
var url = require('url')
var patreon = require('patreon')
var patreonAPI = patreon.patreon
var patreonOAuth = patreon.oauth

// Use the client id and secret you received when setting up your OAuth account
var CLIENT_ID = 'pppp'
var CLIENT_SECRET = 'pppp'
var patreonOAuthClient = patreonOAuth(CLIENT_ID, CLIENT_SECRET)

Using the example code with the correct CLIENT_ID and CLIENT_SECRET, results in the last line of the above code erroring, with the following error:

var patreonOAuthClient = patreonOAuth(CLIENT_ID, CLIENT_SECRET);
TypeError: patreonOAuth is not a function

According to the documentation, and the example therein, that should be a function, yet it isn't.

Vilksian commented 3 years ago

After a bit of digging through the library, I found that the following code seems to work much better:

var URL = require('url');
var { patreon, jsonApiURL, oauth } = require('patreon');
var patreonAPI = patreon
var patreonOAuth = oauth

var CLIENT_ID = 'pppp'
var CLIENT_SECRET = 'pppp'
var patreonOAuthClient = patreonOAuth(CLIENT_ID, CLIENT_SECRET)