Class DeliveryCustomer

A class that extends Customer.

Notice how TypeDoc shows the inheritance hierarchy for our class.

Hierarchy (View Summary)

Customer
- DeliveryCustomer

Index

Constructors

Properties

id name contactName? preferredCourierId? subscriptionType

Accessors

nextOrderNumber

Methods

onOrderPlaced onOrderPlacedArrowFunction isValid

Constructors

constructor

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

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.

`Optional`preferredCourierId

preferredCourierId?: number

A property defined on the subclass.

`Readonly`subscriptionType

subscriptionType: "basic" | "enterprise"

Another property defined on the subclass.

Accessors

nextOrderNumber

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

Returns string
Inherited from Customer.nextOrderNumber
- 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
Inherited from Customer.nextOrderNumber
- 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
Inherited from Customer.onOrderPlaced
- 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
Inherited from Customer.onOrderPlacedArrowFunction
- Defined in example/src/classes/Customer.ts:65

`Protected`isValid

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