TypeDoc Example

    Interface User

    A simple interface. Each property has its own doc comment.

    TypeDoc even supports doc comments on nested type definitions, as shown by the name property.

    interface User {
        id: number;
        email: string;
        name: { first: string; last: string };
    }

    Hierarchy (View Summary)

    Index

    Properties

    id email name

    Properties

    id: number

    The user's ID.

    email: string

    The user's email address.

    name: { first: string; last: string }

    The user's name.

    Type declaration

    • first: string

      The person's given name.

    • last: string

      The person's family name.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR