Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ObjectFilterCondition

An object filter condition is defined as a tuple specifying an object property name - filter expression pair. The filter expression must evaluate to true when applied to the property's value for the condition to become true.

Hierarchy

Index

Properties

0

1

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Methods

[iterator]

[unscopables]

  • [unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean

at

  • Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.

    Parameters

    • index: number

    Returns ObjectFilterProperties | ObjectFilterExpression

concat

copyWithin

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: number

      If not specified, length of the this object is used as its default value.

    Returns ObjectFilterCondition

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ObjectFilterProperties | ObjectFilterExpression]>

every

fill

  • Changes all array elements from start to end index to a static value and returns the modified array

    Parameters

    • value: ObjectFilterProperties | ObjectFilterExpression

      value to fill array section with

    • Optional start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns ObjectFilterCondition

filter

find

findIndex

flat

  • flat<A, D>(depth?: D): FlatArray<A, D>[]
  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • A

    • D: number = 1

    Parameters

    • Optional depth: D

      The maximum recursion depth

    Returns FlatArray<A, D>[]

flatMap

forEach

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

    Parameters

    • searchElement: ObjectFilterProperties | ObjectFilterExpression

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: string): string
  • Adds all the elements of an array into a string, separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

    Parameters

    • searchElement: ObjectFilterProperties | ObjectFilterExpression

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

pop

  • Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

    Returns ObjectFilterProperties | ObjectFilterExpression

push

  • Appends new elements to the end of an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

    Returns (ObjectFilterProperties | ObjectFilterExpression)[]

shift

  • Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

    Returns ObjectFilterProperties | ObjectFilterExpression

slice

  • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

    Parameters

    • Optional start: number

      The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

    • Optional end: number

      The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

    Returns (ObjectFilterProperties | ObjectFilterExpression)[]

some

sort

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: number

      The number of elements to remove.

    Returns (ObjectFilterProperties | ObjectFilterExpression)[]

    An array containing the elements that were deleted.

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: (ObjectFilterProperties | ObjectFilterExpression)[]

      Elements to insert into the array in place of the deleted elements.

    Returns (ObjectFilterProperties | ObjectFilterExpression)[]

    An array containing the elements that were deleted.

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array, and returns the new length of the array.

    Parameters

    Returns number

values

Generated using TypeDoc