@black-flag/checks/dist/packages/checks/src/index.d.ts

A collection of general purpose check functions for yargs and Black Flag

import { BfcErrorMessage } from "./error.js";
export { BfcErrorMessage };
/**
 * A Black Flag check that passes when an argument value is a non-negative
 * number.
 */
export declare function checkIsNotNegative(argName: string): (currentArg: unknown) => string | true;
/**
 * A Black Flag check that passes when an argument value is not falsy.
 */
export declare function checkIsNotNil(argName: string): (currentArg: unknown) => string | true;
/**
 * A Black Flag check that passes when each member of an array-type argument
 * is a non-empty non-nullish value and the array itself is non-empty.
 */
export declare function checkArrayNotEmpty(argName: string, adjective?: string): (currentArg: unknown) => string | true;
/**
 * A Black Flag check that passes when at most only one element from each
 * `conflict` tuple is present in the array.
 */
export declare function checkArrayNoConflicts(argName: string, conflicts: unknown[][]): (currentArg: unknown) => string | true;
/**
 * A Black Flag check that passes when each element in the array is unique.
 */
export declare function checkArrayUnique(argName: string): (currentArg: unknown) => string | true;