Documentation
    Preparing search index...

    Function label

    • Maps each chunk as an object with a "label" and a "value".

      The label can be the result of a property on the chunk.

      Type Parameters

      • T
      • K extends string | number | symbol

      Parameters

      • propName: K

      Returns TransformStream<T, { label: T[K]; value: T }>

      --one--------------------two--------------------three-------------------

      label('length')

      --{label:3,value:'one'}--{label:3,value:'two'}--{label:5,value:'three'}-
    • The label can be the result of calling a provided function.

      Type Parameters

      • T
      • L

      Parameters

      • fn: (chunk: T) => L

      Returns TransformStream<T, { label: L; value: T }>

      --6.1------------------4.2------------------6.3------------------

      label(Math.floor)

      --{label:6,value:6.1}--{label:4,value:4.2}--{label:6,value:6.3}--