TypeDoc Example
    Preparing search index...

    Class CustomerAbstract

    An abstract base class for the customer entity in our application.

    Notice how TypeDoc shows the inheritance hierarchy for our class.

    Hierarchy (View Summary)

    Index

    Constructors

    • The constructor of the Customer class.

      Parameters

      • id: number

        the customer's database ID

      • name: string

        the customer's name

      • nextOrderNumber: string | number

        the next number to use when this customer places an order

      Returns Customer

    Properties

    id: number

    A public readonly property.

    name: string

    A public property that can be reassigned.

    contactName?: string

    An optional protected property.

    Accessors

    • get nextOrderNumber(): string

      A getter that prepends a number sign to the private _nextOrderNumber property.

      Returns string

    • set nextOrderNumber(value: string | number): void

      A setter that takes in either a string or a number and sets the private _nextOrderNumber property.

      Parameters

      • value: string | number

      Returns void

    Methods

    • A public method that's defined using an arrow function.

      TypeDoc knows to document this as a method rather than a property.

      Returns void