Customer
Hierarchy (View Summary)
- Customer
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
new Customer(
id: number,
name: string,
nextOrderNumber: string | number,
): CustomerThe constructor of the Customer class.
Parameters
id: numberthe customer's database ID
name: stringthe customer's name
nextOrderNumber: string | numberthe next number to use when this customer places an order
Returns Customer
Properties
Readonlyid
id: number
A public readonly property.
name
name: string
A public property that can be reassigned.
Protected Optionalcontact
contactName?: string
An optional protected property.
Accessors
next
- get nextOrderNumber(): string
A getter that prepends a number sign to the private
_nextOrderNumberproperty.Returns string
- set nextOrderNumber(value: string | number): void
A setter that takes in either a string or a number and sets the private
_nextOrderNumberproperty.Parameters
value: string | number
Returns void
Methods
on
onOrderPlaced(): voidA public method. To be called when an order is placed for this customer.
Returns void
on
onOrderPlacedArrowFunction(): voidA public method that's defined using an arrow function.
TypeDoc knows to document this as a method rather than a property.
Returns void
Protectedis
isValid(): booleanA protected method.
An abstract base class for the customer entity in our application.
Notice how TypeDoc shows the inheritance hierarchy for our class.