Interface ValidatorArguments<T>

Arguments for a "validator" function.

Type parameters

T

Hierarchy

ScriptArguments
- ValidatorArguments

Index

Properties

Properties

Optional context

context: any

Additional context data, defined by "caller".

emitGlobal

emitGlobal: function

Emits a global event.

param: The event.
param: The arguments.

Type declaration

- (event: string | symbol, ...args: any[]): boolean
- Parameters
  - event: string | symbol
  - Rest ...args: any[]
  Returns boolean

globals

globals: GlobalVariables

The global variables from the settings.

Optional options

options: any

The options for validation.

replaceWithValues

replaceWithValues: function

Handles a value as string and replaces placeholders.

param: The value to parse.
returns: The parsed value.

Type declaration

- (val: any): string
- Parameters
  - val: any
  Returns string

require

require: function

Loads a module from the script context.

param: The ID / path to the module.
returns: The loaded module.

Type declaration

- (id: string): any
- Parameters
  - id: string
  Returns any

value

value: T

The value to check.

Generated using TypeDoc