@stephansama packages / @stephansama/auto-readme / pipeline / parse

Function: parse()

function parse(
   file, 
   filepath, 
   root, 
   config, 
data): Promise<string>;

Defined in: core/auto-readme/src/pipeline.ts:17

Parameters

file

string

filepath

string

root

string

config

Config

data

( | { action: "ACTION"; actionYaml: ActionYaml; body?: undefined; isPnpm?: undefined; parameters: string[]; pkgJson?: undefined; root?: undefined; workspaces?: undefined; } | { action: "PKG"; actionYaml?: undefined; body?: undefined; isPnpm?: undefined; parameters: string[]; pkgJson: PackageJson; root?: undefined; workspaces?: undefined; } | { action: "USAGE"; actionYaml?: undefined; body?: undefined; isPnpm?: undefined; parameters: string[]; pkgJson?: undefined; root?: undefined; workspaces?: undefined; } | { action: "WORKSPACE"; actionYaml?: undefined; body?: undefined; isPnpm: boolean; parameters: string[]; pkgJson?: undefined; root: string; workspaces: Packages; } | { action: "ZOD"; actionYaml?: undefined; body: string; isPnpm?: undefined; parameters: string[]; pkgJson?: undefined; root?: undefined; workspaces?: undefined; })[]

Returns

Promise<string>