Skip to content

loadConfig

function loadConfig(arguments_): Promise<
  | undefined
  | {
  affectedRegexes: string[];
  badgeOptions: {
     dependencyTypes: (
        | "dependencies"
        | "devDependencies"
        | "peerDependencies"
       | "optionalDependencies")[];
     templates: object[];
  };
  collapseHeadings: string[];
  defaultLanguage: "JS" | "RS";
  disableEmojis: boolean;
  disableMarkdownHeadings: boolean;
  enablePrettier: boolean;
  enableToc: boolean;
  enableUsage: boolean;
  headings: Record<"ACTION" | "PKG" | "USAGE" | "WORKSPACE" | "ZOD" | "BADGE",
     | undefined
     | (
     | "default"
     | "description"
     | "devDependency"
     | "downloads"
     | "name"
     | "private"
     | "required"
    | "version")[]>;
  onlyReadmes: boolean;
  onlyShowPublicPackages: boolean;
  removeScope: string;
  templates: {
     downloadImage: string;
     emojis: Record<
        | "default"
        | "description"
        | "devDependency"
        | "downloads"
        | "name"
        | "private"
        | "required"
       | "version", string>;
     registryUrl: string;
     versionImage: string;
  };
  tocHeading: string;
  usageFile: string;
  usageHeading: string;
  verbose: boolean;
}>;

Defined in: core/auto-readme/src/config.ts:16

Parameters

Section titled “Parameters”

arguments_

Section titled “arguments_”

Partial< | { [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; }>

Returns

Section titled “Returns”

Promise< | undefined | { affectedRegexes: string[]; badgeOptions: { dependencyTypes: ( | "dependencies" | "devDependencies" | "peerDependencies" | "optionalDependencies")[]; templates: object[]; }; collapseHeadings: string[]; defaultLanguage: "JS" | "RS"; disableEmojis: boolean; disableMarkdownHeadings: boolean; enablePrettier: boolean; enableToc: boolean; enableUsage: boolean; headings: Record<"ACTION" | "PKG" | "USAGE" | "WORKSPACE" | "ZOD" | "BADGE", | undefined | ( | "default" | "description" | "devDependency" | "downloads" | "name" | "private" | "required" | "version")[]>; onlyReadmes: boolean; onlyShowPublicPackages: boolean; removeScope: string; templates: { downloadImage: string; emojis: Record< | "default" | "description" | "devDependency" | "downloads" | "name" | "private" | "required" | "version", string>; registryUrl: string; versionImage: string; }; tocHeading: string; usageFile: string; usageHeading: string; verbose: boolean; }>