Class CallableFunctionParameter<TModel>Abstract

constructor

• new CallableFunctionParameter<TModel>(name, options?): CallableFunctionParameter<TModel>

• Type Parameters

  • TModel extends {
        $comment?: string;
        default?: any;
        deprecated?: boolean;
        description?: string;
        examples?: any[];
        readOnly?: boolean;
        title?: string;
        writeOnly?: boolean;
    } = {
        $comment?: string;
        default?: any;
        deprecated?: boolean;
        description?: string;
        examples?: any[];
        readOnly?: boolean;
        title?: string;
        writeOnly?: boolean;
    }

  Parameters

  • name: string

  • options: {
        $comment?: string;
        default?: any;
        deprecated?: boolean;
        description?: string;
        examples?: any[];
        readOnly?: boolean;
        title?: string;
        writeOnly?: boolean;
    } = {}

    • Optional $comment?: string

    • Optional default?: any

    • Optional deprecated?: boolean

    • Optional description?: string

    • Optional examples?: any[]

    • Optional readOnly?: boolean

    • Optional title?: string

    • Optional writeOnly?: boolean

  Returns CallableFunctionParameter<TModel>

Optional $comment

Optional default

Optional deprecated

Optional description

Optional examples

id

name

Optional readOnly

Optional title

Readonly Abstract type

Optional writeOnly

Abstract toJSON

• toJSON(): TModel

• Serializes the parameter into a JSON object.

  Returns TModel