@stephansama packages / @stephansama/auto-readme / comment / parseComment

Function: parseComment()

function parseComment(comment): object;

Defined in: core/auto-readme/src/comment.ts:18

Parameters

comment

string

Returns

object

action

action: "ACTION" | "PKG" | "USAGE" | "WORKSPACE" | "ZOD";

format

format: undefined | "LIST" | "TABLE";

isStart

isStart: boolean;

language

language: "JS" | "RS";

parameters

parameters: string[];