-
-
Notifications
You must be signed in to change notification settings - Fork 0
Home
A Node.js wrapper for the Backpack.tf Classifieds Web API.
When you require()
the module, the Classifieds
class is returned. This page lists all methods (properties are private) available from that class.
However, you must first instantiate a new instance of the module and supply it with your Backpack.tf developer API key and User token.
Below is a CommonJS
example:
// Require the module
const { Classifieds } = require('bptf-classifieds');
// and supplying your options
const classifieds = new Classifieds({
token: 'XXXXXXXXXXXXXXXXXXXXXXXX',
apiKey: 'XXXXXXXXXXXXXXXXXXXXXXXX'
});
A list of constructor options is available here.
All methods support both callbacks
and async
/await
.
Also, please note: Function parameters are all supplied in a single object. If one or more are omitted, the function resorts to its default values.
For now, there are some examples available in the test directory.
Feel free to create an issue if you need to report any bugs or have a suggestion for a new feature.