Skip to main content

browserless Adaptor developer README.md

Source: https://github.com/OpenFn/adaptors/tree/main/packages/browserless

@openfn/language-browserless

An OpenFn adaptor for interacting with the Browserless API (PDF generation and related endpoints).

Documentation: https://docs.openfn.org/adaptors/packages/browserless-docs

Documentation​

View the docs site for full technical documentation.

Configuration​

View the configuration-schema for required and optional configuration properties.

Exports​

  • createPDF(input, options): Operation that calls the /pdf endpoint and returns a base64 string for binary responses.
  • request(method, path, options): Generic Browserless-authenticated HTTP operation.

browserless Configuration​

  • state.configuration.baseUrl (optional): Base URL for Browserless (default: https://production-sfo.browserless.io).
  • state.configuration.token (required): Browserless API token for authentication.

Development​

Clone the adaptors monorepo. Follow the "Getting Started" guide inside to get set up.

Run tests using pnpm run test or pnpm run test:watch

Build the project using pnpm build.

To build only the docs run pnpm build docs.