Comment check

This is the call you will make the most. It takes a number of arguments and characteristics about the submitted content and then returns a thumbs up or thumbs down. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. We recommend erring on the side of including too much data.

Client.checkComment(comment: Comment): Promise<CheckResult>

It is important to test Akismet with a significant amount of real, live data in order to draw any conclusions on accuracy. Akismet works by comparing content to genuine spam activity happening right now (and this is based on more than just the content itself), so artificially generating spam comments is not a viable approach.

See the Akismet API documentation for more information.

Parameters

comment: Comment

The Comment providing the user's message to be checked.

Return value

A Promise that resolves with a CheckResult value indicating whether the given Comment is ham, spam or pervasive spam.

Tip

A comment classified as pervasive spam can be safely discarded.

The promise rejects with an Error when an issue occurs. The error message usually includes some debug information, provided by the X-akismet-debug-help HTTP header, about what exactly was invalid about the call.

It can also reject with a custom error code and message (respectively provided by the X-akismet-alert-code and X-akismet-alert-msg headers). See Response Error Codes for more information.

Example

import console from "node:console";
import {Author, Blog, CheckResult, Client, Comment, CommentType} from "@cedx/akismet";

try {
  const author = new Author({
    email: "john.doe@domain.com",
    ipAddress: "192.168.123.456",
    name: "John Doe",
    role: "guest",
    userAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
  });

  const comment = new Comment({
    author,
    date: new Date,
    content: "A user comment.",
    referrer: "https://github.com/cedx/akismet.js",
    type: CommentType.contactForm
  });

  const blog = new Blog({
    charset: "UTF-8",
    languages: ["fr"],
    url: "https://www.yourblog.com"
  });

  const result = await new Client("123YourAPIKey", blog).checkComment(comment);
  console.log(result == CheckResult.ham ? "The comment is ham." : "The comment is spam.");
}
catch (error) {
    const message = error instanceof Error ? error.message : String(error);
    console.log(`An error occurred: ${message}`);
}

See the API reference for detailed information about the Author and Comment classes, and their properties.