@darkobits/saffron/dist/etc/types/SaffronHandlerContext.d.ts

Yargs + Cosmiconfig for robust, configurable CLIs.

import type { SaffronCommonContext } from './SaffronCommonContext';
import type { Arguments } from 'yargs';
/**
 * Context passed to handlers.
 */
export interface SaffronHandlerContext<A, C> extends SaffronCommonContext {
    /**
     * Parsed command line arguments merged with any file-based configuration and
     * validated by Yargs.
     */
    argv: Arguments<A>;
    /**
     * Parsed configuration file, if found.
     */
    config?: C;
    /**
      * Path where Cosmiconfig found a configuration file.
    */
    configPath?: string;
    /**
      * True if Cosmiconfig found a configuration file, but the file was empty.
      */
    configIsEmpty?: boolean;
}