@types/recaptcha2 v1.3.4

Installation

npm install --save @types/recaptcha2

Summary

This package contains type definitions for recaptcha2 (https://github.com/fereidani/recaptcha2#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/recaptcha2.

index.d.ts

// Type definitions for recaptcha2 1.3
// Project: https://github.com/fereidani/recaptcha2#readme
// Definitions by: Jonas Lochmann <https://github.com/l-jonas>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.2

export = Recaptcha2;

declare class Recaptcha2 {
  constructor(options: Recaptcha2.Options);

  getRequestOptions<T extends object>(body: T): Recaptcha2.RequestOptions<T>;
  validate(token: string): Promise<void>;
  validateRequest(req: object, ip: string): Promise<void>;
  translateErrors(errorCodes: string): string;
  translateErrors(errorCodes: string[]): string[];
  formElement(htmlClass: string): string;
}

declare namespace Recaptcha2 {
  interface Options {
    siteKey: string;
    secretKey: string;
    ssl?: boolean | undefined;
  }

  interface RequestOptions<T> {
    uri: string;
    method: 'POST';
    json: true;
    form: T;
  }
}

Additional Details

• Last updated: Thu, 08 Jul 2021 22:41:47 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Jonas Lochmann.