Skip to content

loadActionData

function loadActionData(
   actions,
   file,
   root): Promise<(
  | {
  action: "ACTION";
  actionYaml: ActionYaml;
  body?: undefined;
  catalogs?: undefined;
  isPnpm?: undefined;
  parameters: string[];
  pkgJson?: undefined;
  root?: undefined;
  workspaces?: undefined;
}
  | {
  action: "PKG" | "BADGE";
  actionYaml?: undefined;
  body?: undefined;
  catalogs: {
     catalogs: undefined | Record<string, Catalog>;
     default: undefined | Catalog;
  };
  isPnpm?: undefined;
  parameters: string[];
  pkgJson: PackageJson;
  root?: undefined;
  workspaces?: undefined;
}
  | {
  action: "USAGE";
  actionYaml?: undefined;
  body?: undefined;
  catalogs?: undefined;
  isPnpm?: undefined;
  parameters: string[];
  pkgJson?: undefined;
  root?: undefined;
  workspaces?: undefined;
}
  | {
  action: "WORKSPACE";
  actionYaml?: undefined;
  body?: undefined;
  catalogs?: undefined;
  isPnpm: boolean;
  parameters: string[];
  pkgJson?: undefined;
  root: string;
  workspaces: Packages;
}
  | {
  action: "ZOD";
  actionYaml?: undefined;
  body: string;
  catalogs?: undefined;
  isPnpm?: undefined;
  parameters: string[];
  pkgJson?: undefined;
  root?: undefined;
  workspaces?: undefined;
})[]>;

Defined in: core/auto-readme/src/data.ts:33

Parameters

Section titled “Parameters”

actions

Section titled “actions”

object[]

file

Section titled “file”

string

root

Section titled “root”

string

Returns

Section titled “Returns”

Promise<( | { action: "ACTION"; actionYaml: ActionYaml; body?: undefined; catalogs?: undefined; isPnpm?: undefined; parameters: string[]; pkgJson?: undefined; root?: undefined; workspaces?: undefined; } | { action: "PKG" | "BADGE"; actionYaml?: undefined; body?: undefined; catalogs: { catalogs: undefined | Record<string, Catalog>; default: undefined | Catalog; }; isPnpm?: undefined; parameters: string[]; pkgJson: PackageJson; root?: undefined; workspaces?: undefined; } | { action: "USAGE"; actionYaml?: undefined; body?: undefined; catalogs?: undefined; isPnpm?: undefined; parameters: string[]; pkgJson?: undefined; root?: undefined; workspaces?: undefined; } | { action: "WORKSPACE"; actionYaml?: undefined; body?: undefined; catalogs?: undefined; isPnpm: boolean; parameters: string[]; pkgJson?: undefined; root: string; workspaces: Packages; } | { action: "ZOD"; actionYaml?: undefined; body: string; catalogs?: undefined; isPnpm?: undefined; parameters: string[]; pkgJson?: undefined; root?: undefined; workspaces?: undefined; })[]>