Options
All
  • Public
  • Public/Protected
  • All
Menu

Module drop

Index

References

Functions Array

References

Renames and re-exports drop

Array Functions

  • drop<T>(array: T[], n?: number): T[]
  • Creates a slice of array with n elements dropped from the beginning.

    since

    5.16.0

    example
    drop([1, 2, 3])
    // => [2, 3]

    drop([1, 2, 3], 2)
    // => [3]

    drop([1, 2, 3], 5)
    // => []

    drop([1, 2, 3], 0)
    // => [1, 2, 3]

    Type parameters

    • T

    Parameters

    • array: T[]

      The array to query.

    • n: number = 1

      The number of elements to drop.

    Returns T[]

    Returns the slice of array.