/**
 * @module api-function-info.template is a template for implementing api function infos (obviously).
 *
 * ## notes
 *
 * ### ordering imports
 *
 * import sections always go:
 * 1. non-ibgib deps first (rare)
 * 2. @ibgib/helper-gib, @ibgib/encrypt-gib, @ibgib/ts-gib, @ibgib/core-gib packages (in that order)
 * 3. import GLOBAL_LOG_A_LOT then remaining project imports
 * 4. code proper starts with the definition of `const logalot` (if applicable)
 *
 * There is a blank line between these sections.
 *
 */
import { APIFunctionInfo } from "../../api-types.mjs";
import { CommandDataBase } from "../command-types.mjs";
/**
 * fooCategory could be 'agent', 'renderable', etc. It's the broad command which
 * basically acts like a category of commands at this point.
 *
 * If an agent is generating this, ask me what this should be before going forward.
 */
declare const CMD_CATEGORY = "fooCategory";
/**
 * fooBar here is the specific command modifier which narrows down to a command
 * instance, similar to a fully curried function.
 *
 * This should be camelCased actual name of the function.
 */
declare const CMD_MODIFIERS: string[];
/**
 * @interface FooBarOpts - Options for the fooBar command.
 *
 * @extends CommandDataBase
 */
export interface FooBarOpts extends CommandDataBase<typeof CMD_CATEGORY, typeof CMD_MODIFIERS> {
    /**
     * @property fooArgString - always include the docs here in the opts interface
     */
    fooArgString: string;
    /**
     * @property fooArgArray - always include the docs here in the opts interface
     */
    fooArgArray: string;
}
/**
 * @interface FooBarCommandData - Command data for the fooBar command.
 * @extends CommandDataBase
 */
export interface FooBarCommandData extends CommandDataBase<'agent', ['fooBar']> {
    /**
     * @see {@link FooBarOpts.fooArgString}
     */
    fooArgString: string;
    /**
     * @see {@link FooBarOpts.fooArgArray}
     */
    fooArgArray: string;
}
/**
 * Wrapper function to enqueue the fooBar command.
 * @param {FooBarOpts} opts - @see {@link FooBarOpts}
 * @returns {Promise<void>} A promise that resolves when the command finishes execution.
 */
declare function fooBarViaCmd(opts: FooBarOpts): Promise<void>;
/**
 * API function info for the fooBar command.
 */
export declare const fooBarFunctionInfo: APIFunctionInfo<typeof fooBarViaCmd>;
export {};
//# sourceMappingURL=api-function-info.template.d.mts.map