Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "iter/extend-sides"

Index

Functions

Functions

extendSides

  • extendSides<T>(src: Iterable<T>, numLeft?: number, numRight?: number): IterableIterator<T>
  • Yields iterator of given iterable which repeats the first and/or last value(s) numLeft/numRight times (default: 1).

    remarks

    By default both sides are repeated, but can be adjusted by setting either of them to zero. numRight defaults to same value as numLeft.

    example
    [...extendSides([1, 2, 3])]
    // [ 1,  1, 2, 3,  3]
    
    [...extendSides([1, 2, 3], 3)]
    // [ 1, 1, 1,  1, 2, 3,  3, 3, 3 ]
    
    [...extendSides([1, 2, 3], 0, 3)]
    // [ 1, 2, 3,  3, 3, 3 ]

    Type parameters

    • T

    Parameters

    • src: Iterable<T>

      -

    • Default value numLeft: number = 1

      -

    • Default value numRight: number = numLeft

      -

    Returns IterableIterator<T>

Generated using TypeDoc