Function paginateMap

paginateMap<T>(
    ctx: CommandContext,
    items: T[],
    mapper: (item: T) => SectionBuilder,
    topSection?: T,
    currentPage?: number,
    pageSize?: number,
    header?: string,
): Promise<MessagePagination<SectionBuilder>>
Map arbitrary items into SectionBuilder instances and call paginate.

The mapper must have the signature (item: T, builder: SectionBuilder) => SectionBuilder. A fresh SectionBuilder instance is provided as the second argument to the mapper for each item; the mapper should populate and return that builder (or return a new SectionBuilder).
Type Parameters
- T
  item type to map
Parameters
- ctx: CommandContext
  CommandContext
- items: T[]
  original items to map
- mapper: (item: T) => SectionBuilder
  mapping function (item) => SectionBuilder.
- OptionaltopSection: T
  optional top section value (will be converted by calling mapper(topSection))
- OptionalcurrentPage: number
  initial page (default: 1)
- OptionalpageSize: number
  items per page (default: 10)
- Optionalheader: string
  optional header text
Returns Promise<MessagePagination<SectionBuilder>>
A MessagePagination instance
Example
```
// mapper that fills the provided builder per item
await paginateMap(
  ctx,
  users,
  (user) => new SectionBuilder().addTextDisplayComponents(t => t.setContent(user.name)),
  null,
  1,
  10,
  "Users",
);
```
- Defined in pagination.ts:387
paginateMap<T>(
    ctx: CommandContext,
    items: T[],
    mapper: (item: T) => TextDisplayBuilder,
    topSection?: T,
    currentPage?: number,
    pageSize?: number,
    header?: string,
): Promise<MessagePagination<TextDisplayBuilder>>
Map arbitrary items into SectionBuilder instances and call paginate.

The mapper must have the signature (item: T, builder: SectionBuilder) => SectionBuilder. A fresh SectionBuilder instance is provided as the second argument to the mapper for each item; the mapper should populate and return that builder (or return a new SectionBuilder).
Type Parameters
- T
  item type to map
Parameters
- ctx: CommandContext
  CommandContext
- items: T[]
  original items to map
- mapper: (item: T) => TextDisplayBuilder
  mapping function (item) => SectionBuilder.
- OptionaltopSection: T
  optional top section value (will be converted by calling mapper(topSection))
- OptionalcurrentPage: number
  initial page (default: 1)
- OptionalpageSize: number
  items per page (default: 10)
- Optionalheader: string
  optional header text
Returns Promise<MessagePagination<TextDisplayBuilder>>
A MessagePagination instance
Example
```
// mapper that fills the provided builder per item
await paginateMap(
  ctx,
  users,
  (user) => new SectionBuilder().addTextDisplayComponents(t => t.setContent(user.name)),
  null,
  1,
  10,
  "Users",
);
```
- Defined in pagination.ts:396

Function paginateMap

Type Parameters

Parameters

Returns Promise<MessagePagination<SectionBuilder>>

Example

Type Parameters

Parameters

Returns Promise<MessagePagination<TextDisplayBuilder>>

Example

Settings