Brought to you by Allons-y Studio

Type Alias: OpxConfig<PluginName, PluginConfig>

type OpxConfig<PluginName, PluginConfig> = {
  $schema?: string;
  version: 1;
} & DynamicTaskConfig<PluginName, PluginConfig> & StaticTaskConfig;

Defined in: detector.ts:63

The contents of .opx/config.json.

Type Declaration

$schema?

optional $schema?: string;

URL of the JSON schema that editors use to validate the file.

version

version: 1;

The config format version.

Type Parameters

Type Parameter Default type Description
PluginName extends string string The plugin short names allowed as keys.
PluginConfig Record<string, unknown> The settings object a plugin accepts.