Gauntlet Environment

Overview

Environment API provides information about the environment in which the plugin is running and additional information about runtime

Example

src/environment.tsx

import { Environment } from "@project-gauntlet/api/helpers";

export default function Command() {
    console.log(Environment.gauntletVersion)
    console.log(Environment.isDevelopment)
    console.log(Environment.pluginDataDir)
    console.log(Environment.pluginCacheDir)
}

gauntlet.toml

[[entrypoint]]
id = 'environment'
name = 'Environment'
path = 'src/environment.tsx'
type = 'command'
description = ''

Environment.gauntletVersion

Type: number

Returns currently Gauntlet version

Environment.isDevelopment

Type: boolean

Returns true if the plugin was installed using npm run dev command from dev tools as opposed to Settings UI

Environment.pluginDataDir

Type: string

Returns absolute path to directory that is assigned to current plugin only and is meant for storing general data. If writing or reading to/from this directory Plugin must declare it in permissions using {common:plugin-data} path variable. The directory will be created automatically during plugin startup

Environment.pluginCacheDir

Type: string

Returns absolute path to directory that is assigned to current plugin only and is meant for storing cache. If writing or reading to/from this directory Plugin must declare it in permissions using {common:plugin-cache} path variable. The directory will be created automatically during plugin startup