Skip to content

parseArguments

function parseArguments(): Promise<
  | {
[key: string]: unknown;
  _: (string | number)[];
  $0: string;
  badgeOptions: unknown;
  changes: boolean;
  check: boolean;
  config: undefined | string;
  defaultLanguage: unknown;
  disableEmojis: unknown;
  disableMarkdownHeadings: unknown;
  enablePrettier: unknown;
  enableToc: unknown;
  enableUsage: unknown;
  onlyReadmes: unknown;
  onlyShowPublicPackages: unknown;
  removeScope: unknown;
  tocHeading: unknown;
  usageFile: unknown;
  usageHeading: unknown;
  verbose: unknown;
}
  | {
[key: string]: unknown;
  _: (string | number)[];
  $0: string;
  badgeOptions: unknown;
  changes: boolean;
  check: boolean;
  config: undefined | string;
  defaultLanguage: unknown;
  disableEmojis: unknown;
  disableMarkdownHeadings: unknown;
  enablePrettier: unknown;
  enableToc: unknown;
  enableUsage: unknown;
  onlyReadmes: unknown;
  onlyShowPublicPackages: unknown;
  removeScope: unknown;
  tocHeading: unknown;
  usageFile: unknown;
  usageHeading: unknown;
  verbose: unknown;
}>;

Defined in: core/auto-readme/src/arguments.ts:36

Returns

Section titled “Returns”

Promise< | { [key: string]: unknown; _: (string | number)[]; $0: string; badgeOptions: unknown; changes: boolean; check: boolean; config: undefined | string; defaultLanguage: unknown; disableEmojis: unknown; disableMarkdownHeadings: unknown; enablePrettier: unknown; enableToc: unknown; enableUsage: unknown; onlyReadmes: unknown; onlyShowPublicPackages: unknown; removeScope: unknown; tocHeading: unknown; usageFile: unknown; usageHeading: unknown; verbose: unknown; } | { [key: string]: unknown; _: (string | number)[]; $0: string; badgeOptions: unknown; changes: boolean; check: boolean; config: undefined | string; defaultLanguage: unknown; disableEmojis: unknown; disableMarkdownHeadings: unknown; enablePrettier: unknown; enableToc: unknown; enableUsage: unknown; onlyReadmes: unknown; onlyShowPublicPackages: unknown; removeScope: unknown; tocHeading: unknown; usageFile: unknown; usageHeading: unknown; verbose: unknown; }>