Type Alias DefineSpec<TOptions, TArgs, TOpts, TGlobal>

DefineSpec: Omit<
    GetDotenvCliPlugin<TOptions, TArgs, TOpts, TGlobal>,
    "children" | "use" | "setup",
> & {
    ns: string;
    setup: (
        cli: GetDotenvCliPublic<TOptions, TArgs, TOpts, TGlobal>,
    ) => void | Promise<void>;
}

Public spec type for defining a plugin with compositional helpers.

Type Parameters

TOptions extends GetDotenvOptions = GetDotenvOptions
TArgs extends unknown[] = []
TOpts extends OptionValues = {}
TGlobal extends OptionValues = {}

Type Declaration

ns: string
Required namespace and setup function. The host creates the mount and passes it into setup; return void | Promise.
setup: (
cli: GetDotenvCliPublic<TOptions, TArgs, TOpts, TGlobal>,
) => void | Promise<void>