pols-utils - v5.3.11
    Preparing search index...

    Function extractOne

    • Extracts (removes and returns) the first element in an array that matches the given logical selector.

      Type Parameters

      • T

        The type of elements in the array.

      • K = T

        The return type of the transformation function, if provided.

      Parameters

      • array: T[]

        The target array to search and mutate.

      • logicalSelector: PLogicalSelector<T>

        The selector used to identify the matching element. This can be either a predicate function or an object for property-based matching.

      • Optionaltransform: (element: T, i: number) => K

        A function to transform the selected element before returning it.

      Returns K

      The first matching element, optionally transformed. Returns undefined if no match if found.

      const pets = [
      { type: 'dog', name: 'Fido' },
      { type: 'dog', name: 'Chacalin' },
      { type: 'cat', name: 'Mr. Brown' },
      { type: 'cat', name: 'Night' },
      ]
      console.log(PUtilsArray.extractOne(pets, pet => pet.type === 'dog'))
      // => { type: 'dog', name: 'Fido' }

      console.log(pets)
      // => [
      // { type: 'dog', name: 'Chacalin' },
      // { type: 'cat', name: 'Mr. Brown' },
      // { type: 'cat', name: 'Night' },
      // ]