@rocket/cli
Version:
38 lines • 1.08 kB
TypeScript
/** @typedef {import('../../types/upgrade.js').upgrade} upgrade */
/**
*
* @param {upgrade} options
*/
export function upgrade202203menu({ files, folderRenames }: upgrade): Promise<{
files: import("../../types/upgrade.js").UpgradeFile[];
folderRenames: import("../../types/upgrade.js").FolderRename[];
}>;
/**
* Reads a text and extracts a title from it
*
* @param {string} content The text where to extract the title from
* @param {string} engine
*/
export function extractTitle(content: string, engine?: string): {
title: string;
lineNumber: number;
};
/**
* Parses a title and extracts the relevante data for it.
* A title can contain
* - ">>" to define a parent => child relationship
* - "||" to define the order for this page
*
* @example
* Foo ||3
* Foo >> Bar ||10
*
* @param {string} inTitle
* @return {{ title: string, order: number }}
*/
export function parseTitle(inTitle: string): {
title: string;
order: number;
};
export type upgrade = import('../../types/upgrade.js').upgrade;
//# sourceMappingURL=upgrade202203menu.d.ts.map