Skip to main content
#Referencia

MarkpdfClient

string
requerido
Su clave API. Si no lo aprueba, el cliente lee Bun.env.MARKPDF_API_KEY.
string
predeterminado:"https://api.markpdf.tech"
URL base de API.
number
predeterminado:"300000"
Tiempo de espera por solicitud en milisegundos.
number
predeterminado:"2"
Reintentos automáticos con retroceso exponencial en 429 y 5xx.
boolean
predeterminado:"true"
Si el servidor responde 202 (backends saturados), automáticamente sondea GET /jobs/{id}. Se puede sobrescribir mediante llamada.

Métodos

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

convertFile

Abre path con Bun.file(path) y lo pasa como cuerpo de POST /convert/raw: Bun transmite el archivo directamente al socket, sin pasar por un Buffer intermedio. El filename se infiere del nombre base de path.

convertBytes

Igual que convertFile, pero para datos ya cargados en la memoria (por ejemplo, el cuerpo de un Request entrante).

convertFromUrl

Llama a POST /convert/from-url.

convertStream

Generador asíncrono que emite fragmentos de Markdown a medida que llegan desde POST /convert/stream, leyendo el archivo con Bun.file(path). Consulte Transmisión y asíncrono.

pdfIndex

Llame a POST /pdf/index. Devuelve el lomo escrito.

getJob

Consulta manualmente GET /jobs/{id}.

waitForJob

Sondea GET /jobs/{id} hasta que el estado sea completed o failed, o hasta que se agote timeoutMs. Usado internamente por autoPoll: true.

Tipos

ConversionResult

PdfSpine

JobStatus

Todos los tipos se exportan desde @markpdf/bun: