Class Honeypot

Module used to implement a Honeypot. A Honeypot is a visually hidden input that is used to detect spam bots. This field is expected to be left empty by users because they don't see it, but bots will fill it falling in the honeypot trap.

Index

Constructors

Properties

Accessors

encryptionSeed nameFieldName validFromFieldName

Methods

check decrypt encrypt getInputProps getRandomizedNameFieldName isFuture isValidTimeStamp randomValue shouldCheckHoneypot

Constructors

constructor

new Honeypot(config?: HoneypotConfig): Honeypot
Parameters
- config: HoneypotConfig = {}
Returns Honeypot
- Defined in src/server/honeypot.ts:60

Properties

`Protected`config

config: HoneypotConfig

Accessors

`Protected`encryptionSeed

get encryptionSeed(): string
Returns string
- Defined in src/server/honeypot.ts:126

`Protected`nameFieldName

get nameFieldName(): string
Returns string
- Defined in src/server/honeypot.ts:113

`Protected`validFromFieldName

get validFromFieldName(): null | string
Returns null | string
- Defined in src/server/honeypot.ts:119

Methods

check

check(formData: FormData): Promise<void>
Parameters
- formData: FormData
Returns Promise<void>
- Defined in src/server/honeypot.ts:80

`Protected`decrypt

decrypt(value: string): Promise<string>
Parameters
- value: string
Returns Promise<string>
- Defined in src/server/honeypot.ts:158

`Protected`encrypt

encrypt(value: string): Promise<string>
Parameters
- value: string
Returns Promise<string>
- Defined in src/server/honeypot.ts:154

getInputProps

getInputProps(
options?: { validFromTimestamp?: number },
): Promise<HoneypotInputProps>
Get the HoneypotInputProps to be used in your forms.
Parameters
- options: { validFromTimestamp?: number } = {}
  The options for the input props.
  - OptionalvalidFromTimestamp?: number
    Since when the timestamp is valid.
Returns Promise<HoneypotInputProps>
The props to be used in the form.
- Defined in src/server/honeypot.ts:70

`Protected`getRandomizedNameFieldName

getRandomizedNameFieldName(
nameFieldName: string,
formData: FormData,
): undefined | string
Parameters
- nameFieldName: string
- formData: FormData
Returns undefined | string
- Defined in src/server/honeypot.ts:130

`Protected`isFuture

isFuture(timestamp: number): boolean
Parameters
- timestamp: number
Returns boolean
- Defined in src/server/honeypot.ts:162

`Protected`isValidTimeStamp

isValidTimeStamp(timestampp: number): boolean
Parameters
- timestampp: number
Returns boolean
- Defined in src/server/honeypot.ts:166

`Protected`randomValue

randomValue(): string
Returns string
- Defined in src/server/honeypot.ts:150

`Protected`shouldCheckHoneypot

shouldCheckHoneypot(formData: FormData, nameFieldName: string): boolean
Parameters
- formData: FormData
- nameFieldName: string
Returns boolean
- Defined in src/server/honeypot.ts:140