Nog CLI Developer Guide - v0.11.0
    Preparing search index...

    Utility class for building TypeScript method parameters. Designed to be injected via DI.

    Index

    Constructors

    Methods

    • Builds an inline object parameter with JSDoc comments for each property. Handles properties with special characters (like HTTP headers) using string literals.

      Parameters

      Returns ParameterDeclaration

      params?: { apiKey: string; 'X-Custom-Header'?: string; }
      
    • Builds a standard method parameter.

      Parameters

      • name: string
      • typeNode: TypeNode
      • isOptional: boolean = false

      Returns ParameterDeclaration

      body: UserDto
      
    • Builds a params?: { query?: {...}; headers?: {...} } parameter, omitting the query or headers branches when their property list is empty. Returns null when both branches are empty.

      Keeping query and headers in separate sub-objects (rather than one flat record) lets the runtime RequestBuilder apply each set under its own OpenAPI rules without having to disambiguate by name.

      Parameters

      Returns ParameterDeclaration | null