mirror of
https://github.com/firecrawl/anydoc.git
synced 2026-09-14 14:18:33 +08:00
tomsideguide
42 lines
1.4 KiB
TypeScript
42 lines
1.4 KiB
TypeScript
export * from './index.js'
|
|
import type { Format } from './index.js'
|
|
|
|
/** What happens to a PDF whose pages need OCR. */
|
|
export interface ConvertOptions {
|
|
/**
|
|
* `reject` (the default) rejects with `needsOcr` naming the pages.
|
|
* `hosted` sends the document to Firecrawl Parse instead, through the
|
|
* `firecrawl` package (an optional peer dependency). Documents anydoc
|
|
* converts itself never leave the machine.
|
|
*/
|
|
ocr?: 'reject' | 'hosted'
|
|
/**
|
|
* Firecrawl API key for `hosted`, else `FIRECRAWL_API_KEY`; without either
|
|
* the keyless tier applies, rate-limited per IP.
|
|
*/
|
|
apiKey?: string
|
|
}
|
|
|
|
/**
|
|
* Convert a document file to Markdown. The format is detected from the file
|
|
* content; the extension is the fallback for signature-less formats (CSV)
|
|
* and unrecognizable containers.
|
|
*
|
|
* Rejects with an `Error` carrying a `ConvertErrorCode` on `code`; a file
|
|
* that cannot be read is `'io'`.
|
|
*/
|
|
export declare function toMarkdown(path: string, options?: ConvertOptions): Promise<string>
|
|
|
|
/**
|
|
* Convert an in-memory document to Markdown. Without a format, it is
|
|
* detected from the content, which signature-less formats (CSV) have to name
|
|
* explicitly.
|
|
*
|
|
* Rejects with an `Error` carrying a `ConvertErrorCode` on `code`.
|
|
*/
|
|
export declare function toMarkdownBytes(
|
|
bytes: Uint8Array,
|
|
format?: Format | null,
|
|
options?: ConvertOptions,
|
|
): Promise<string>
|