Full Nodejs bindings to the Akismet (https://akismet.com) spam detection service.
- Promise and callback support
- Supports all active versions of node (4 to 9)
- Supports all Akismet API features
- Uses a modern HTTP client
- Complete test suite
- No coffeescript
Upgrading to 4.0? You likely don't need to change anything, but check out the changelog.
npm install akismet-api
Creating the Client
The blog and key values are required by Akismet. There are a set of other avaliable default options visible in the source, but you likely will not need to change those.
var akismet = ;var client = akismet;
Promises and Callbacks
All of the function methods below support both promises and callbacks!
The returned promises use the Bluebird promise library.
The following documentation primarily uses the callback version, but to return a promise simply don't provide a callback.
Here is an example of the promise version of the
Verifying your Key
It's a good idea to verify your key before use. If your key returns as invalid, the error field will contain the debug help message returned by Akismet.
Checking for Spam
The user_ip, user_agent, and referrer are required options. All other options are optional, but will provide you with better spam detection accuracy.
Submitting False Negatives
If Akismet reports something as not-spam, but it turns out to be spam anyways, we can report this to Akismet via this API call.
Submitting False Positives
If Akismet reports something as spam, but it turns out to not be spam anyways, we can report this to Akismet via this API call.
cd node_modules/akismet-apinpm test
Released under the MIT license.
See LICENSE.txt for more information.