rdme/dist/lib/exportDocs.d.ts

ReadMe's official CLI and GitHub Action.

import type { APIv2PageExportCommands } from '../index.js';
import type { PageRequestSchema } from '../types.js';
type ChangelogsRequestSchema = PageRequestSchema<'changelogs'>;
type CustomPagesRequestSchema = PageRequestSchema<'custom_pages'>;
type GuidesOrReferenceRequestSchema = PageRequestSchema<'guides' | 'reference'>;
type GeneralRequestSchema = ChangelogsRequestSchema | CustomPagesRequestSchema | GuidesOrReferenceRequestSchema;
export interface FullExportResults {
    completed: GeneralRequestSchema[];
    failed: string[];
    skipped: number;
}
export declare function exportDocs(this: APIv2PageExportCommands): Promise<FullExportResults>;
export {};