Skip to content

DOCXKIT_PLUGIN_NOT_REGISTERED: Plugin not registered ​

A plugin node references a runtime name that has not been registered. PDK assertions also reuse this code for invalid plugin instances.

What to do ​

  1. Call the plugin factory and pass the returned instance to .use() before export.
  2. Match the node name to plugin.name; third-party factory names may differ.
  3. JSON DSL plugins must also be registered.

Problem example ​

ts
import { createDocx } from 'docx-kit'

await createDocx()
  .plugin('qrcode', { text: 'https://example.com' })
  .toBlob()

Corrected example ​

ts
import { createDocx, qrcodePlugin } from 'docx-kit'

const doc = createDocx()
  .use(qrcodePlugin())
  .plugin('qrcode', { text: 'https://example.com' })
const blob = await doc.toBlob()

Common causes ​

  • Missing .use(), a factory that was not called, or a runtime name mismatch.

Diagnostic fields ​

Example message ​

text
Plugin not registered: qrcode

Released under the MIT License.