Class UsageWriter

Generates a USAGE.md file with comprehensive usage documentation for the generated SDK.

The generated documentation includes:

API metadata (title, version, generation timestamp)
Installation instructions
Configuration examples
Error handling patterns
Complete list of available services from the OpenAPI specification

This writer does not use ts-morph AST manipulation since it generates plain Markdown.

Index

Constructors

Methods

Constructors

constructor

new UsageWriter(
    project: Project,
    outputDir: string,
    specTitle?: string,
    specVersion?: string,
): UsageWriter
Instantiates the usage documentation writer.
Parameters
- project: Project
  The ts-morph Project instance (used only for file creation).
- outputDir: string
  The target directory where USAGE.md will be written.
- specTitle: string = 'Unknown Spec'
  The OpenAPI specification title.
- specVersion: string = 'Unknown Version'
  The OpenAPI specification version.
Returns UsageWriter
- Defined in core/generator/writers/usage.writer.ts:30

Methods

write

write(ir: IrDefinition): Promise<void>
Generates and writes the USAGE.md file based on the IR definition.
Parameters
- ir: IrDefinition
  The Internal Representation containing services and metadata.
Returns Promise<void>
- Defined in core/generator/writers/usage.writer.ts:42