Skip to content

[api-documenter] Properties with function values are not recognized as functions #3031

@fhinkel

Description

@fhinkel

When a class function is defined as a class property rather than a method, it's description lacks the parameters.docfx then renders it as a property without params or parentheses.

Property with function value:

createReadStream: () => Readable;

Same function defined as method:

createReadStream(): Readable {
  return new Readable();
}

The first gets rendered as in the pic when it should be createdReadStream() analogous to the methods further down.

Screen Shot 2021-11-24 at 11 26 21 AM

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions