Class Customer`Abstract`

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

Notice how TypeDoc shows the inheritance hierarchy for our class.

Hierarchy (View Summary)

Customer
- DeliveryCustomer
- WalkInCustomer

Index

Constructors

Properties

id name contactName?

Accessors

nextOrderNumber

Methods

onOrderPlaced onOrderPlacedArrowFunction isValid

Constructors

constructor

new Customer(
    id: number,
    name: string,
    nextOrderNumber: string | number,
): Customer
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
- Defined in example/src/classes/Customer.ts:48

Properties

`Readonly`id

id: number

A public readonly property.

name

name: string

A public property that can be reassigned.

`Protected` `Optional`contactName

contactName?: string

An optional protected property.

Accessors

nextOrderNumber

get nextOrderNumber(): string
A getter that prepends a number sign to the private _nextOrderNumber property.

Returns string
- Defined in example/src/classes/Customer.ts:25
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
- Defined in example/src/classes/Customer.ts:33

Methods

onOrderPlaced

onOrderPlaced(): void
A public method. To be called when an order is placed for this customer.

Returns void
- Defined in example/src/classes/Customer.ts:56

onOrderPlacedArrowFunction

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
- Defined in example/src/classes/Customer.ts:65

`Protected`isValid

isValid(): boolean
A protected method.

Returns boolean
- Defined in example/src/classes/Customer.ts:70