Skip to main content
#Referencia

MarkpdfClient

string
requerido
Su clave API. Si no lo pasa, el cliente lee process.env.MARKPDF_API_KEY (Nodo) o Deno.env (Deno).
string
predeterminado:"https://api.markpdf.tech"
URL base de API.
number
predeterminado:"300000"
Tiempo de espera por solicitud en milisegundos, implementado con AbortController.
number
predeterminado:"2"
Reintentos automáticos con retroceso exponencial en 429 y 5xx.
typeof fetch
Implementación de fetch para usar. De forma predeterminada, utiliza el fetch global del tiempo de ejecución. Útil para inyectar un fetch con un proxy o para pruebas.

Métodos

Todos aceptan las mismas opciones que los parámetros de consulta de API, en camelCase.

convertFile

Sube contenido a POST /convert/raw. Devuelve Promise<string> con Markdown, o Promise<ConversionResult> si responseFormat: "json".
boolean
predeterminado:"true"
Si el servidor responde 202 (backends saturados), SDK sondea automáticamente GET /jobs/{id}. Con autoPoll: false, el método arroja MarkpdfJobQueuedError con jobId para realizar una encuesta manual. Consulte Transmisión y asíncrono.

convertFromUrl

Llama a POST /convert/from-url.

convertStream

Devuelve un AsyncIterable<string> que emite fragmentos de Markdown a medida que llegan antes de POST /convert/stream o /convert/stream-from-url. Consulte Transmisión y asíncrono.

pdfIndex

Llame a POST /pdf/index. Devuelve el lomo escrito: los mismos campos que POST /pdf/index.

getJob

Consulta manualmente GET /jobs/{id}.

Tipos

ConversionResult

PdfSpine

JobStatus

Todos los tipos se exportan desde @markpdf/sdk para que los utilices en tu propio código: