Documentation
    Preparing search index...

    Type Alias RcFile

    Shape of the adonisrc.js configuration file. This is the main configuration file that defines the application structure, providers, preloads, and other essential settings.

    const rcFile: RcFile = {
      typescript: true,
      directories: { ... },
      providers: [...],
      preloads: [...],
      // ... other configurations
    }
    type RcFile = {
        typescript: boolean;
        directories: DirectoriesNode & { [key: string]: string };
        preloads: PreloadNode[];
        metaFiles: MetaFileNode[];
        providers: ProviderNode[];
        commands: (() => Promise<any>)[];
        commandsAliases: { [key: string]: string };
        hooks: AssemblerRcFile["hooks"];
        tests: {
            suites: {
                name: string;
                files: string | string[];
                directories: string[];
                timeout?: number;
            }[];
            forceExit: boolean;
            timeout: number;
        };
        raw: Record<string, any>;
        experimental: ExperimentalFlagsList;
    }
    Index

    Properties

    typescript directories preloads metaFiles providers commands commandsAliases hooks tests raw experimental

    Properties

    typescript: boolean

    Indicates whether this is a TypeScript project.

    directories: DirectoriesNode & { [key: string]: string }

    List of configured directories for the application. Combines standard AdonisJS directories with custom ones.

    preloads: PreloadNode[]

    Array of files to preload after the application has been booted. These files are automatically imported based on environment.

    metaFiles: MetaFileNode[]

    Array of meta files to watch for changes. Used by development tools to trigger server reloads.

    providers: ProviderNode[]

    Providers to register in the IoC container. Providers are registered based on their environment configuration.

    commands: (() => Promise<any>)[]

    Array of Ace commands to register. Each entry is a function that imports a command class.

    commandsAliases: { [key: string]: string }

    Custom aliases for Ace commands. Maps alias names to actual command names.

    { 'm:c': 'make:controller', 'serve': 'serve' }
    hooks: AssemblerRcFile["hooks"]

    Assembler hooks configuration for build processes. Hooks are executed during various build lifecycle events.

    tests: {
        suites: {
            name: string;
            files: string | string[];
            directories: string[];
            timeout?: number;
        }[];
        forceExit: boolean;
        timeout: number;
    }

    Test suites configuration for the application. Defines test files, directories, and execution settings.

    raw: Record<string, any>

    Reference to the raw contents of the adonisrc.js file. Contains the original, unprocessed configuration object.

    experimental: ExperimentalFlagsList

    Flags to enable experimental features. Can be extended by packages to add their own experimental options.

    Settings

    Member Visibility

    On This Page

    Properties