Interface ParameterData

Data for a method parameter in MethodData#parameters

interface ParameterData {
    annotations: string[];
    description: null | NodeContent;
    entityType: "parameter";
    id: string;
    name: string;
    signature: string;
    type: string;
}

Properties

annotations: string[]

The parameter's applied annotations.

description: null | NodeContent

The entity's description, if any.

entityType: "parameter"

The entity's type.

id: string

The entity's unique id (relative to others in the same context). Used as key in collections.

Specifically:

In classes, enums, interfaces, external objects and annotations: the qualifiedName.
In packages, enum constants, fields, method type parameters, object type parameters and parameters: the name.
In methods: the prototype, to avoid conflicts with overloaded methods.

name: string

The entity's name.

signature: string

The entity's signature.

type: string

The parameter's type.