Query | miniSphere

Represents an iterable collection with query transformations applied. Queries can be looped over using for..of or additional query operations can be chained to produce a new query.

Type parameters

T

Hierarchy

Query

Implements

Iterable<T>

Index

Methods

Methods

__@iterator

__@iterator(): Iterator<T>

- Defined in lib.sphere.d.ts:1617
Returns Iterator<T>

all

all(predicate: function): boolean

- Defined in lib.sphere.d.ts:1620
Run the query and check if all results pass the given predicate function.

Parameters
- predicate: function
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns boolean

allIn

allIn(values: Iterable<T>): boolean

- Defined in lib.sphere.d.ts:1622
Parameters
- values: Iterable<T>
Returns boolean

any

any(predicate: function): boolean

- Defined in lib.sphere.d.ts:1623
Parameters
- predicate: function
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns boolean

anyIn

anyIn(values: Iterable<T>): boolean

- Defined in lib.sphere.d.ts:1624
Parameters
- values: Iterable<T>
Returns boolean

anyIs

anyIs(value: T): boolean

- Defined in lib.sphere.d.ts:1625
Parameters
- value: T
Returns boolean

ascending

ascending<K>(keySelector?: function): Query<T>

- Defined in lib.sphere.d.ts:1626
Type parameters
- K
Parameters
- Optional keySelector: function
  - - (value: T): K
    - Parameters
      - value: T
      Returns K
Returns Query<T>

besides

besides(callback: function): Query<T>

- Defined in lib.sphere.d.ts:1627
Parameters
- callback: function
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
Returns Query<T>

concat

concat(...sources: Iterable<T>[]): Query<T>

- Defined in lib.sphere.d.ts:1628
Parameters
- Rest ...sources: Iterable<T>[]
Returns Query<T>

count

count(): number

- Defined in lib.sphere.d.ts:1629
Returns number

countBy

countBy<K>(keySelector: function): Record<K, number>

- Defined in lib.sphere.d.ts:1630
Type parameters
- K: string
Parameters
- keySelector: function
  - - (value: T): K
    - Parameters
      - value: T
      Returns K
Returns Record<K, number>

descending

descending<K>(keySelector?: function): Query<T>

- Defined in lib.sphere.d.ts:1631
Type parameters
- K
Parameters
- Optional keySelector: function
  - - (value: T): K
    - Parameters
      - value: T
      Returns K
Returns Query<T>

drop

drop(count: number): Query<T>

- Defined in lib.sphere.d.ts:1632
Parameters
- count: number
Returns Query<T>

dropLast

dropLast(count: number): Query<T>

- Defined in lib.sphere.d.ts:1633
Parameters
- count: number
Returns Query<T>

dropWhile

dropWhile(predicate: function): Query<T>

- Defined in lib.sphere.d.ts:1634
Parameters
- predicate: function
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns Query<T>

first

first(predicate?: function): T

- Defined in lib.sphere.d.ts:1635
Parameters
- Optional predicate: function
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns T

forEach

forEach(iteratee: function): void

- Defined in lib.sphere.d.ts:1641
Run the query and call a function for each result.

Parameters
- iteratee: function
  
  A function to call for each result. Its return value is ignored.
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
Returns void

groupBy

groupBy<K>(keySelector: function): Record<K, T[]>

- Defined in lib.sphere.d.ts:1643
Type parameters
- K: string
Parameters
- keySelector: function
  - - (value: T): K
    - Parameters
      - value: T
      Returns K
Returns Record<K, T[]>

join

join<U, R>(joinSource: Iterable<U>, predicate: function, selector: function): Query<R>

- Defined in lib.sphere.d.ts:1644
Type parameters
- U
- R
Parameters
- joinSource: Iterable<U>
- predicate: function
  - - (left: T, right: U): boolean
    - Parameters
      - left: T
      - right: U
      Returns boolean
- selector: function
  - - (left: T, right: U): R
    - Parameters
      - left: T
      - right: U
      Returns R
Returns Query<R>

last

last(predicate?: function): T

- Defined in lib.sphere.d.ts:1645
Parameters
- Optional predicate: function
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns T

memoize

memoize(): Query<T>

- Defined in lib.sphere.d.ts:1646
Returns Query<T>

over

over<R>(selector: function): Query<R>

- Defined in lib.sphere.d.ts:1647
Type parameters
- R
Parameters
- selector: function
  - - (value: T): Iterable<R>
    - Parameters
      - value: T
      Returns Iterable<R>
Returns Query<R>

plus

plus(...values: T[]): Query<T>

- Defined in lib.sphere.d.ts:1648
Parameters
- Rest ...values: T[]
Returns Query<T>

pull

pull(...values: T[]): Query<T>

- Defined in lib.sphere.d.ts:1649
Parameters
- Rest ...values: T[]
Returns Query<T>

random

random(count: number): Query<T>

- Defined in lib.sphere.d.ts:1650
Parameters
- count: number
Returns Query<T>

reduce

reduce<R>(reducer: function, seed: R): R

- Defined in lib.sphere.d.ts:1651
Type parameters
- R
Parameters
- reducer: function
  - - (accumulator: R, value: T): R
    - Parameters
      - accumulator: R
      - value: T
      Returns R
- seed: R
Returns R

remove

remove(predicate: function): void

- Defined in lib.sphere.d.ts:1652
Parameters
- predicate: function
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns void

reverse

reverse(): Query<T>

- Defined in lib.sphere.d.ts:1658
Reverse the query results so the last result is returned first.

Returns Query<T>

A new query for the reversed sequence.

sample

sample(count: number): Query<T>

- Defined in lib.sphere.d.ts:1660
Parameters
- count: number
Returns Query<T>

select

select<R>(selector: function): Query<R>

- Defined in lib.sphere.d.ts:1667
Transform query results using a mapping function.

Type parameters
- R
Parameters
- selector: function
  
  A callback that takes a query result and returns the transformed value.
  - - (value: T): R
    - Parameters
      - value: T
      Returns R
Returns Query<R>

A new query for the transformed results.

shuffle

shuffle(): Query<T>

- Defined in lib.sphere.d.ts:1669
Returns Query<T>

take

take(count: number): Query<T>

- Defined in lib.sphere.d.ts:1670
Parameters
- count: number
Returns Query<T>

takeLast

takeLast(count: number): Query<T>

- Defined in lib.sphere.d.ts:1671
Parameters
- count: number
Returns Query<T>

takeWhile

takeWhile(predicate: function): Query<T>

- Defined in lib.sphere.d.ts:1672
Parameters
- predicate: function
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns Query<T>

thru

thru<R>(transform: function): Query<R>

- Defined in lib.sphere.d.ts:1673
Type parameters
- R
Parameters
- transform: function
  - - (values: T[]): Iterable<R>
    - Parameters
      - values: T[]
      Returns Iterable<R>
Returns Query<R>

toArray

toArray(): T[]

- Defined in lib.sphere.d.ts:1674
Returns T[]

uniq

uniq(): Query<T>
uniq<K>(predicate: function): Query<T>

- Defined in lib.sphere.d.ts:1675
Returns Query<T>
- Defined in lib.sphere.d.ts:1676
Type parameters
- K
Parameters
- predicate: function
  - - (value: T): K
    - Parameters
      - value: T
      Returns K
Returns Query<T>

update

update<R>(selector: function): void

- Defined in lib.sphere.d.ts:1677
Type parameters
- R
Parameters
- selector: function
  - - (value: T): R
    - Parameters
      - value: T
      Returns R
Returns void

valueAt

valueAt(index: number): T | undefined

- Defined in lib.sphere.d.ts:1678
Parameters
- index: number
Returns T | undefined

where

where(predicate: function): Query<T>

- Defined in lib.sphere.d.ts:1685
Query for values that satisfy a given predicate function.

Parameters
- predicate: function
  
  A callback that returns true to keep a value or false to discard it.
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns Query<T>

A new query for the filtered results.

without

without(...values: T[]): Query<T>

- Defined in lib.sphere.d.ts:1687
Parameters
- Rest ...values: T[]
Returns Query<T>

zip

zip<U>(zipSource: Iterable<U>): Query<[T, U]>
zip<U, R>(zipSource: Iterable<U>, selector: function): Query<R>

- Defined in lib.sphere.d.ts:1688
Type parameters
- U
Parameters
- zipSource: Iterable<U>
Returns Query<[T, U]>
- Defined in lib.sphere.d.ts:1689
Type parameters
- U
- R
Parameters
- zipSource: Iterable<U>
- selector: function
  - - (left: T, right: U): R
    - Parameters
      - left: T
      - right: U
      Returns R
Returns Query<R>

Generated using TypeDoc