Search

Search something to see results

TypeDocGitHub

DeliveryCustomer

A class that extends Customer.

Notice how TypeDoc shows the inheritance hierarchy for our class.

Hierarchy (View Summary)

Index

Constructors

DeliveryCustomer.constructor

Properties

DeliveryCustomer.idDeliveryCustomer.nameDeliveryCustomer.contactNameDeliveryCustomer.preferredCourierIdDeliveryCustomer.subscriptionType

Accessors

DeliveryCustomer.nextOrderNumber

Methods

DeliveryCustomer.onOrderPlacedDeliveryCustomer.onOrderPlacedArrowFunctionDeliveryCustomer.isValid

Constructors

new DeliveryCustomer(
    id: number,
    name: string,
    nextOrderNumber: string | number,
    subscriptionType: "basic" | "enterprise",
): DeliveryCustomer

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

onOrderPlaced(): void

A public method. To be called when an order is placed for this customer.

Returns void

onOrderPlacedArrowFunction(): void

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

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

Returns void

isValid(): boolean

An example of overriding a protected method.

A DeliveryCustomer can only have a preferred courier if its subscription type is enterprise.

Returns boolean