@promptbook/remote-client
Version:
Promptbook: Turn your company's scattered knowledge into AI ready books
37 lines (36 loc) • 1.35 kB
TypeScript
import type { string_markdown } from '../../types/typeAliases';
/**
* Single code block inside markdown.
*/
export type CodeBlock = {
/**
* Which notation was used to open the code block
*/
readonly blockNotation: '```' | '>';
/**
* Language of the code block OR null if the language is not specified in opening ```
*/
readonly language: string | null;
/**
* Content of the code block (unescaped)
*/
readonly content: string;
};
/**
* Extracts all code blocks from markdown.
*
* Note: There are multiple similar functions:
* - `extractBlock` just extracts the content of the code block which is also used as built-in function for postprocessing
* - `extractJsonBlock` extracts exactly one valid JSON code block
* - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
* - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
*
* @param markdown any valid markdown
* @returns code blocks with language and content
* @throws {ParseError} if block is not closed properly
* @public exported from `@promptbook/markdown-utils`
*/
export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): ReadonlyArray<CodeBlock>;
/**
* TODO: Maybe name for `blockNotation` instead of '```' and '>'
*/