TypeDoc Example

    Class DeliveryCustomer

    A class that extends Customer.

    Notice how TypeDoc shows the inheritance hierarchy for our class.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    id name contactName? preferredCourierId? subscriptionType

    Accessors

    nextOrderNumber

    Methods

    onOrderPlaced onOrderPlacedArrowFunction isValid

    Constructors

    • The constructor of the DeliveryCustomer 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

      • subscriptionType: "basic" | "enterprise"

        whether this customer has a basic or enterprise subscription

      Returns DeliveryCustomer

    Properties

    id: number

    A public readonly property.

    name: string

    A public property that can be reassigned.

    contactName?: string

    An optional protected property.

    preferredCourierId?: number

    A property defined on the subclass.

    subscriptionType: "basic" | "enterprise"

    Another property defined on the subclass.

    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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    MMNEPVFCICPMFPCPTTAAATR