search

twitchtv / igdb-api-node

Nodejs Wrapper for IGDB.com API. Requires an API key. Get one at:
https://api.igdb.com/
MIT License
128 stars 15 forks source link

API Documentation not correct or not specified correctly on how to use the API! #40

Closed imdoingotherthings closed 4 years ago

imdoingotherthings commented 4 years ago

Using the new API (apicalypse) there seems to be an issue on how to use the api. In the IGDB discord, I mentioned that after importing the new wrapper (node - apicalypse) I had to console log apicalypse to find { default: [Function function] }.

Now the reason why I looked for this was because I was receiving an error that said apicalypse is not a function.

It was also in the unofficial docs for a node module: [https://www.npmjs.com/package/igdb-api-node] stating in installation and setup const igdb = require('igdb-api-node').default;

This also applies to the new apicalypse wrapper.

dustyjewett commented 4 years ago

I'm afraid I don't understand what isn't correct. The docs clearly have two sections, one for ES5 (which is the require version) and one for ES6 (the import version)

If you would like to fork the repo and suggest changes, we welcome Pull Requests.