@notion-md-converter/core
Version:
Notion to Markdown Converter
79 lines (78 loc) • 5.22 kB
TypeScript
import type { ApiColor, Block, BookmarkBlock, BookmarkTransformer, BreadcrumbBlock, BreadcrumbTransformer, BulletedListItemBlock, BulletedListItemTransformer, CalloutBlock, CalloutTransformer, ChildDatabaseBlock, ChildDatabaseTransformer, ChildPageBlock, ChildPageTransformer, CodeBlock, CodeTransformer, ColumnListBlock, ColumnListTransformer, Context, DividerBlock, DividerTransformer, EmbedBlock, EmbedTransformer, EquationBlock, EquationTransformer, FileBlock, FileTransformer, Heading1Block, Heading2Block, Heading3Block, HeadingTransformer, ImageBlock, ImageTransformer, LinkPreviewBlock, LinkPreviewTransformer, NumberedListItemBlock, NumberedListItemTransformer, PDFTransformer, ParagraphBlock, ParagraphTransformer, PdfBlock, QuoteBlock, QuoteTransformer, RichText, SyncedBlock, SyncedBlockTransformer, TableBlock, TableOfContentsBlock, TableOfContentsTransformer, TableRowBlock, TableTransformer, ToDoBlock, ToDoTransformer, ToggleBlock, ToggleTransformer, VideoBlock, VideoTransformer } from "@notion-md-converter/types";
import { CaptionMetadata } from "../rich-text";
export declare class UnsupportedBlockError extends Error {
constructor(block: Block);
}
type BaseBlockArg<T extends Block> = {
block: T;
context: Context<T>;
};
export type ExecuteFunction<T extends Block, TExtra = Record<string, unknown>> = (arg: BaseBlockArg<T> & TExtra) => string | null;
export declare const createBookmarkTransformerFactory: (execute: ExecuteFunction<BookmarkBlock, {
captionMetadata: CaptionMetadata;
}>) => BookmarkTransformer;
export declare const createBreadcrumbTransformerFactory: (execute: ExecuteFunction<BreadcrumbBlock>) => BreadcrumbTransformer;
export declare const createCalloutTransformerFactory: (execute: ExecuteFunction<CalloutBlock, {
children: string;
}>) => CalloutTransformer;
export declare const createCodeTransformerFactory: (execute: ExecuteFunction<CodeBlock, {
captionMetadata: CaptionMetadata;
}>) => CodeTransformer;
export declare const createColumnListTransformerFactory: (execute: ExecuteFunction<ColumnListBlock, {
columns: string[];
}>) => ColumnListTransformer;
export declare const createDividerTransformerFactory: (execute: ExecuteFunction<DividerBlock>) => DividerTransformer;
export declare const createEquationTransformerFactory: (execute: ExecuteFunction<EquationBlock>) => EquationTransformer;
export declare const createFileTransformerFactory: (execute: ExecuteFunction<FileBlock, {
captionMetadata: CaptionMetadata;
}>) => FileTransformer;
export declare const createHeadingTransformerFactory: (execute: ExecuteFunction<Heading1Block | Heading2Block | Heading3Block, {
level: 1 | 2 | 3;
richText: RichText[];
isToggleable: boolean;
color: ApiColor;
}>) => HeadingTransformer;
export declare const createImageTransformerFactory: (execute: ExecuteFunction<ImageBlock, {
captionMetadata: CaptionMetadata;
}>) => ImageTransformer;
export declare const createLinkPreviewTransformerFactory: (execute: ExecuteFunction<LinkPreviewBlock>) => LinkPreviewTransformer;
export declare const createBulletedListItemTransformerFactory: (execute: ExecuteFunction<BulletedListItemBlock, {
children: string;
}>) => BulletedListItemTransformer;
export declare const createNumberedListItemTransformerFactory: (execute: ExecuteFunction<NumberedListItemBlock, {
children: string;
index: number;
}>) => NumberedListItemTransformer;
export declare const createTodoTransformerFactory: (execute: ExecuteFunction<ToDoBlock, {
children: string;
}>) => ToDoTransformer;
export declare const createParagraphTransformerFactory: (execute: ExecuteFunction<ParagraphBlock, {
children: string;
}>) => ParagraphTransformer;
export declare const createPDFTransformerFactory: (execute: ExecuteFunction<PdfBlock, {
captionMetadata: CaptionMetadata;
}>) => PDFTransformer;
export declare const createQuoteTransformerFactory: (execute: ExecuteFunction<QuoteBlock, {
children: string;
}>) => QuoteTransformer;
export declare const createSyncedBlockTransformerFactory: (execute: ExecuteFunction<SyncedBlock, {
isSynchronizationSource: boolean;
children: string;
}>) => SyncedBlockTransformer;
export declare const createTableOfContentsTransformerFactory: (execute: ExecuteFunction<TableOfContentsBlock>) => TableOfContentsTransformer;
export declare const createTableTransformerFactory: (execute: ExecuteFunction<TableBlock, {
header: TableRowBlock;
rows: TableRowBlock[];
}>) => TableTransformer;
export declare const createToggleTransformerFactory: (execute: ExecuteFunction<ToggleBlock, {
children: string;
}>) => ToggleTransformer;
export declare const createVideoTransformerFactory: (execute: ExecuteFunction<VideoBlock, {
captionMetadata: CaptionMetadata;
}>) => VideoTransformer;
export declare const createEmbedTransformerFactory: (execute: ExecuteFunction<EmbedBlock, {
captionMetadata: CaptionMetadata;
}>) => EmbedTransformer;
export declare const createChildDatabaseTransformerFactory: (execute: ExecuteFunction<ChildDatabaseBlock>) => ChildDatabaseTransformer;
export declare const createChildPageTransformerFactory: (execute: ExecuteFunction<ChildPageBlock>) => ChildPageTransformer;
export {};