Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "xform/page"

Index

Functions

Functions

page

  • page<T>(page: number, pageLen?: undefined | number): Transducer<T, T>
  • page<T>(page: number, src: Iterable<T>): IterableIterator<T>
  • page<T>(page: number, pageLen: number, src: Iterable<T>): IterableIterator<T>
  • Pagination helper. Returns transducer which extracts only items for given page number (and page length, default 10).

    remarks

    When {@link (comp:1) | composing} with other transducers, it's most efficient if page is used as early as possible / prior to any heavy processing steps.

    example
    [...page(0, 5, range(12))]
    // [ 0, 1, 2, 3, 4 ]
    
    [...page(1, 5, range(12))]
    // [ 5, 6, 7, 8, 9 ]
    
    [...page(2, 5, range(12))]
    // [ 10, 11 ]
    
    [...page(3, 5, range(12))]
    // []

    Type parameters

    • T

    Parameters

    • page: number

      -

    • Optional pageLen: undefined | number

      -

    Returns Transducer<T, T>

  • Type parameters

    • T

    Parameters

    • page: number
    • src: Iterable<T>

    Returns IterableIterator<T>

  • Type parameters

    • T

    Parameters

    • page: number
    • pageLen: number
    • src: Iterable<T>

    Returns IterableIterator<T>

Generated using TypeDoc