@black-flag/extensions/dist/packages/extensions/src/error.d.ts

A collection of set-theoretic declarative-first APIs for yargs and Black Flag

import type { Entries } from 'type-fest';
export type KeyValueEntries = Entries<{
  [x: string]: unknown;
}>;
export type KeyValueEntry = KeyValueEntries[number];
/**
 * A collection of possible error and warning messages.
 */
export declare const BfeErrorMessage: {
  FalsyCommandExport(): string;
  CommandHandlerNotAFunction(): string;
  ReferencedNonExistentOption(referrerName: string, doesNotExistName: string): string;
  DuplicateOptionName(name: string): string;
  IllegalHandlerInvocation(): string;
  MetadataInvariantViolated(afflictedKey: string): string;
  UnexpectedlyFalsyDetailedArguments(): string;
  UnexpectedValueFromInternalYargsMethod(): string;
  RequiresViolation(requirer: string, missingRequiredKeyValues: KeyValueEntries): string;
  ConflictsViolation(conflicter: string, seenConflictingKeyValues: KeyValueEntries): string;
  ImpliesViolation(implier: string, seenConflictingKeyValues: KeyValueEntries): string;
  DemandIfViolation(demanded: string, demander: KeyValueEntry): string;
  DemandOrViolation(demanded: KeyValueEntries): string;
  DemandGenericXorViolation(demanded: KeyValueEntries): string;
  DemandSpecificXorViolation(firstArgument: KeyValueEntry, secondArgument: KeyValueEntry): string;
  CheckFailed(currentArgument: string): string;
  GuruMeditation(): string;
  BuilderCalledOnInvalidPass(pass: "first-pass" | "second-pass"): string;
  BuilderCannotBeAsync(commandName: string): string;
  Generic(): string;
  CommandNotImplemented(): string;
  InvalidSubCommandInvocation(): string;
  FrameworkError(error: unknown): string;
  GracefulEarlyExit(): string;
  ConfigLoadFailure(path: string): string;
  InvalidConfigureArgumentsReturnType(): string;
  InvalidConfigureExecutionEpilogueReturnType(): string;
  InvalidConfigureExecutionContextReturnType(): string;
  InvalidExecutionContextBadField(fieldName: string): string;
  InvalidCharacters(str: string, violation: string): string;
  PathIsNotDirectory(): string;
  DuplicateCommandName(parentFullName: string | undefined, name1: string, type1: "name" | "alias", name2: string, type2: "name" | "alias"): string;
  InvalidCommandExportBadStart(name: string): string;
  InvalidCommandExportBadPositionals(name: string): string;
  NoConfigurationLoaded(path: string): string;
  BadConfigurationPath(path: unknown): string;
  InvocationNotAllowed(name: string): string;
  CannotExecuteMultipleTimes(): string;
  BadParameterCombination(): string;
  UseParseAsyncInstead(): string;
};