Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "xform/map-nth"

Index

Functions

Functions

mapNth

  • mapNth<A, B>(n: number, fn: Fn<A, B>): Transducer<A, A | B>
  • mapNth<A, B>(n: number, offset: number, fn: Fn<A, B>): Transducer<A, A | B>
  • mapNth<A, B>(n: number, fn: Fn<A, B>, src: Iterable<A>): IterableIterator<A | B>
  • mapNth<A, B>(n: number, offset: number, fn: Fn<A, B>, src: Iterable<A>): IterableIterator<A | B>
  • Transducer. Similar to {@link (map:1)}, but only transforms every n-th input value and passes intermediate values unchanged downstream.

    remarks

    The optional offset arg can be used to adjust the number of inputs before the first transformation occurs (default 0).

    example
    [...mapNth(3, (x) => x * 10, range(1,10))]
    // [ 10, 2, 3, 40, 5, 6, 70, 8, 9 ]
    
    // with offset
    [...mapNth(3, 5, (x) => x * 10, range(1,10))]
    // [ 1, 2, 3, 4, 5, 60, 7, 8, 90 ]

    Type parameters

    • A

    • B

    Parameters

    • n: number

      step size

    • fn: Fn<A, B>

      transformation function

    Returns Transducer<A, A | B>

  • Type parameters

    • A

    • B

    Parameters

    • n: number
    • offset: number
    • fn: Fn<A, B>

    Returns Transducer<A, A | B>

  • Type parameters

    • A

    • B

    Parameters

    • n: number
    • fn: Fn<A, B>
    • src: Iterable<A>

    Returns IterableIterator<A | B>

  • Type parameters

    • A

    • B

    Parameters

    • n: number
    • offset: number
    • fn: Fn<A, B>
    • src: Iterable<A>

    Returns IterableIterator<A | B>

Generated using TypeDoc