Home > @microsoft/api-extractor-model > Parameter

Parameter class

Represents a named parameter for a function-like declaration.

Signature:

export declare class Parameter 

Constructors

Constructor Modifiers Description
(constructor)(options)   Constructs a new instance of the Parameter class

Properties

Property Modifiers Type Description
name   string The parameter name.
parameterTypeExcerpt   Excerpt An Excerpt that describes the type of the parameter.
tsdocParamBlock   tsdoc.DocParamBlock | undefined Returns the @param documentation for this parameter, if present.

Remarks

Parameter represents a TypeScript declaration such as x: number in this example:

export function add(x: number, y: number): number {
  return x + y;
}

Parameter objects belong to the collection.