Class Client

constructor

• new Client(apiKey, blog, options?): Client

• Creates a new client.

  Parameters

  • apiKey: string

    The Akismet API key.
  • blog: Blog

    The front page or home URL of the instance making requests.
  • options: Partial<ClientOptions> = {}

    An object providing values to initialize this instance.

  Returns Client

Readonly apiKey

Readonly baseUrl

Readonly blog

Readonly isTest

Readonly userAgent

checkComment

• checkComment(comment): Promise<number>

• Checks the specified comment against the service database, and returns a value indicating whether it is spam.

  Parameters

  • comment: Comment

    The comment to be checked.

  Returns Promise<number>

  A value indicating whether the specified comment is spam.

submitHam

• submitHam(comment): Promise<void>

• Submits the specified comment that was incorrectly marked as spam but should not have been.

  Parameters

  • comment: Comment

    The comment to be submitted.

  Returns Promise<void>

  Resolves once the comment has been submitted.

submitSpam

• submitSpam(comment): Promise<void>

• Submits the specified comment that was not marked as spam but should have been.

  Parameters

  • comment: Comment

    The comment to be submitted.

  Returns Promise<void>

  Resolves once the comment has been submitted.

verifyKey

• verifyKey(): Promise<boolean>

• Checks the API key against the service database, and returns a value indicating whether it is valid.

  Returns Promise<boolean>

  true if the specified API key is valid, otherwise false.