Skip to content

PluginInput

Import from @varavel/vdl-plugin-sdk.

type PluginInput = object;

PluginInput represents the data payload sent to a plugin.

The plugin receives this as a single argument containing the complete Intermediate Representation of the VDL schema along with any user-defined configuration options from vdl.config.vdl.

Properties

Property Type Description
ir IrSchema The complete VDL Intermediate Representation. Contains all types, enums, constants, and documentation from the compiled schema, fully resolved and ready for code generation.
options Record\<string, string> Arbitrary key-value options passed from the vdl.config.vdl plugin configuration. These allow users to customize plugin behavior without modifying the plugin itself. Common use cases include specifying target frameworks, API versions, naming conventions, or feature flags.
version string The VDL binary version (without v prefix, e.g. 1.0.0)