Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Configs

Match Configurations. Has 5 specified fields. All other fields are up to user discretion

Hierarchy

  • Configs

Indexable

[key: string]: any

Match Configurations. Has 5 specified fields. All other fields are up to user discretion

Index

Properties

agentOptions

agentOptions: DeepPartial<Options>

Default Agent options to use for all agents in a match. Commonly used for setting resource use boundaries

agentSpecificOptions

agentSpecificOptions: Array<DeepPartial<Options>>

Agent options to lastly overridde with depending on agent index

default

[] - empty array meaning no more overrides

detached

detached: boolean

Whether to run in detached mode. When in detached mode (true), the match can initialize within dimensions using the Design but will now instead update step by step

default

false

engineOptions

engineOptions: DeepPartial<EngineOptions>

The engine options to use in this match.

languageSpecificAgentOptions

languageSpecificAgentOptions: LanguageSpecificOptions

Agent options to override with depending on extension of file

default

{} - an empty object

loggingLevel

loggingLevel: LEVEL

Logging level for this match.

see

Logger

name

name: string

Name of the match

secureMode

secureMode: boolean

Whether to run match in secure mode or not

default

true

storeErrorDirectory

storeErrorDirectory: string

Directory to store error logs locally. When a Storage plugin is used, this indicates the path in the bucket to store the log in, and removes the local copy.

default

errorlogs

storeErrorLogs

storeErrorLogs: boolean

Whether to store error output for each Match

default

true

storeMatchErrorLogs

storeMatchErrorLogs: boolean

Whether to store error and warnings outputted by match from calling match.throw

default

false

storeReplay

storeReplay: boolean

Whether or not to store a replay file if match results indicate a replay file was stored

default

true

storeReplayDirectory

storeReplayDirectory: string

Used only when a Storage plugin is used. Indicates the directory to use to store onto the storage. (Typically some path in the bucket).

default

replays

Generated using TypeDoc