Class Section<T, N>`Abstract`

All sections are structured the same way, so this abstract class is used to reduce code duplication

Remarks

All sections must have between 1 and N elements
All sections must have a title if more than 1 section is provided

Type Parameters

T
The type of the components of the section
N extends number
The maximum number of elements in the section

Hierarchy (View Summary)

ClientLimitedMessageComponent<T, N>
- Section
  - ListSection
  - ProductSection

Index

Constructors

Properties

Constructors

constructor

new Section<T, N extends number>(
    name: string,
    keys_name: string,
    elements: AtLeastOne<T>,
    max: N,
    title?: string,
    title_length?: number,
): Section<T, N>
Builds a section component
Type Parameters
- T
  The type of the components of the section
- N extends number
  The maximum number of elements in the section
Parameters
- name: string
  The name of the section's type
- keys_name: string
  The name of the section's keys
- elements: AtLeastOne<T>
  The elements of the section
- max: N
  The maximum number of elements in the section
- Optionaltitle: string
  The title of the section
- title_length: number = 24
  The maximum length of the title
Returns Section<T, N>
Throws
If more than N elements are provided

Throws
If title is over 24 characters if provided
Overrides ClientLimitedMessageComponent.constructor
- Defined in types.ts:258

Properties

`Optional` `Readonly`title

title?: string

The title of the section