Skip to main content

lib/dev

Development mode utilities for controlling module loading.

This module provides utilities for filtering which modules are loaded during development. It reads FiveM convars to determine development mode settings.

Convars

  • dev_mode: Set to "true" to enable development mode filtering
  • dev_features: Comma-separated list of module names to load (empty = load all)

Usage in server.cfg

# Enable dev mode and only load specific modules
set dev_mode "true"
set dev_features "spawning,characters,banking"

# Or load all modules in dev mode (just skip the filter)
set dev_mode "true"
set dev_features ""

Usage in Code

import { DEV, ONLY, enabled } from "@core/dev";

// Check if we're in dev mode
if (DEV) {
console.log("Running in development mode");
}

// Check if a specific module should be loaded
if (enabled("my-module")) {
// Load the module
}

Variables

DEV

const DEV: boolean;

Defined in: src/lib/dev.ts:48

Whether development mode is enabled. Read from the dev_mode convar (default: "false").


ONLY

const ONLY: Set<string>;

Defined in: src/lib/dev.ts:55

Set of module names to load in dev mode. Read from the dev_features convar as a comma-separated list. Empty set means all modules should load.

Functions

FunctionDescription
enabledChecks if a module should be enabled based on dev mode settings.