interface AdditionalExport

Define additional constants, classes, functions, or types to be included in generated version files. Supports various export types with TypeScript compatibility.

Examples

Example 1

const additionalExport: AdditionalExport = {
  name: "CONFIG",
  type: "const",
  value: { apiUrl: "https://api.example.com", timeout: 5000 },
  description: "Application configuration",
  asConst: true
};

Properties

name: string

Export name (must be a valid JavaScript identifier)

type:
"const"
| "let"
| "var"
| "class"
| "function"
| "interface"
| "type"
| "enum"

Export type

optional
content: string

For complex types like classes and functions, provide the body content. The export declaration will be automatically generated based on the type.

optional
value: unknown

For simple value exports, provide the JavaScript value. Objects and arrays will be JSON stringified automatically.

optional
description: string

Optional JSDoc comment description

optional
asConst: boolean

Whether to add "as const" assertion (for TypeScript const exports)

optional
async: boolean

Whether this export is async (for functions)

optional
isDefault: boolean

Whether this export is default

Usage

import { type AdditionalExport } from ".";