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

    Interface IrParameter

    Represents a single parameter for an HTTP operation. Each IrParameter becomes a method argument in the generated service.

    interface IrParameter {
        description?: string;
        in: "query" | "path" | "body" | "header";
        isRequired: boolean;
        name: string;
        type: IrType;
    }
    Index

    Properties

    description? in isRequired name type

    Properties

    description?: string

    Optional description from the OpenAPI parameter. Used to generate JSDoc comments for individual parameters in the params object.

    in: "query" | "path" | "body" | "header"

    The location of this parameter in the HTTP request.

    • 'path': URL path parameter (e.g., /users/{id})
    • 'query': URL query string parameter (e.g., ?limit=10)
    • 'body': Request body (POST/PUT/PATCH)
    • 'header': HTTP header (e.g., Authorization)
    isRequired: boolean

    Indicates if this parameter is required. When false, the parameter becomes optional in the generated method signature.

    Required path param: `getUserById(id: string)`

    Optional query param: `listUsers(limit?: number)`
    name: string

    The parameter name in camelCase. Used as the method argument name.

    'userId'

    'limit'

    'body'
    type: IrType

    The type of this parameter. For body parameters, typically references a DTO model.

    Settings

    Member Visibility

    On This Page

    Properties