Renderer API

Once you've bundled your documents using format compile or one of our bundler plugins, you can interface with it by importing it. What you import is called a renderer. You call it, generally with a blob of data to render down your bundle to HTML for the API.

import { invoice } from './_generated'

const doc = await invoice.render({ customerName: 'Ada Lovelace' })

import { invoice } from '@format:documents'

const doc = await invoice.render({ customerName: 'Ada Lovelace' })

The name of your document directory is converted to camelCase and used as the export name.

You can also use the default export to access all renderers:

import documents from './_generated'

const doc = await documents.invoice.render({ ... })

import documents from '@format:documents'

const doc = await documents.invoice.render({ ... })

Methods

Details