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.

Hierarchy

Properties

id email name

Properties

id

id: number

The user's ID.

email

email: string

The user's email address.

name

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.

On This Page

Generated using TypeDoc