Interface Underscore

Index

Methods

Methods

public after(func: Function): Function

Wrapped type number.

see

_.after

Parameters

  • func: Function

Returns

Function

public all(iterator?: ListIterator, context?: any): boolean

Wrapped type any[].

see

_.all

Parameters

Returns

boolean

public any(iterator?: ListIterator, context?: any): boolean

Wrapped type any[].

see

_.any

Parameters

Returns

boolean

public bind(object: any, arguments?: Array<any>): Function

Wrapped type Function.

see

_.bind

Parameters

  • object: any
  • arguments?: Array<any> optional

Returns

Function

public bindAll(methodNames?: Array<string>): any

Wrapped type object.

see

_.bindAll

Parameters

  • methodNames?: Array<string> optional

Returns

any

public chain(): _Chain

Wrapped type any.

see

_.chain

Returns

_Chain

public clone(): T in Underscore<T>

Wrapped type any[].

see

_.clone

Returns

T in Underscore<T>

public collect(iterator: ListIterator, context?: any): Array<TResult>

see

_.map

Parameters

Returns

Array<TResult>

public collect(iterator: ObjectIterator, context?: any): Array<TResult>

see

_.map

Parameters

Returns

Array<TResult>

public compact(): Array<T>

Wrapped type any[].

see

_.compact

Returns

Array<T>

public compose(functions?: Array<Function>): Function

Wrapped type Function[].

see

_.compose

Parameters

  • functions?: Array<Function> optional

Returns

Function

public constant(): () => T

Wrapped type any.

see

_.constant

Returns

() => T

public contains(value: T in Underscore<T>): boolean

Wrapped type any[].

see

_.contains

Parameters

  • value: T in Underscore<T>

Returns

boolean

public countBy(iterator?: ListIterator, context?: any): Dictionary

Wrapped type any[].

see

_.countBy

Parameters

Returns

Dictionary

public countBy(iterator: string, context?: any): Dictionary

Wrapped type any[].

see

_.countBy

Parameters

  • iterator: string
  • context?: any optional

Returns

Dictionary

public debounce(wait: number, immediate?: boolean): Function

Wrapped type Function.

see

_.debounce

Parameters

  • wait: number
  • immediate?: boolean optional

Returns

Function

public defaults(defaults?: Array<any>): any

Wrapped type object.

see

_.defaults

Parameters

  • defaults?: Array<any> optional

Returns

any

public defer(arguments?: Array<any>)

Wrapped type Function.

see

_.defer

Parameters

  • arguments?: Array<any> optional

public delay(wait: number, arguments?: Array<any>): any

Wrapped type Function.

see

_.delay

Parameters

  • wait: number
  • arguments?: Array<any> optional

Returns

any

public delay(arguments?: Array<any>): any

see

_.delay

Parameters

  • arguments?: Array<any> optional

Returns

any

public detect(iterator: ListIterator, context?: any): T in Underscore<T>

see

_.find

Parameters

Returns

T in Underscore<T>

public difference(others?: List[]): Array<T>

Wrapped type any[].

see

_.difference

Parameters

  • others?: List[] optional

Returns

Array<T>

public drop(n?: number): Array<T>

see

_.rest

Parameters

  • n?: number optional

Returns

Array<T>

public each(iterator: ListIterator, context?: any): Array<T>

Wrapped type any[].

see

_.each

Parameters

Returns

Array<T>

public each(iterator: ObjectIterator, context?: any): Array<T>

see

_.each

Parameters

Returns

Array<T>

public escape(): string

Wrapped type string.

see

_.escape

Returns

string

public every(iterator?: ListIterator, context?: any): boolean

see

_.all

Parameters

Returns

boolean

public extend(sources?: Array<any>): any

Wrapped type object.

see

_.extend

Parameters

  • sources?: Array<any> optional

Returns

any

public filter(iterator: ListIterator, context?: any): Array<T>

Wrapped type any[].

see

_.filter

Parameters

Returns

Array<T>

public find(iterator: ListIterator, context?: any): T in Underscore<T>

Wrapped type any[].

see

_.find

Parameters

Returns

T in Underscore<T>

public findWhere(properties: U): T in Underscore<T>

Wrapped type any[].

see

_.findWhere

Parameters

  • properties: U

Returns

T in Underscore<T>

public first(): T in Underscore<T>

Wrapped type any[].

see

_.first

Returns

T in Underscore<T>

public first(n: number): Array<T>

Wrapped type any[].

see

_.first

Parameters

  • n: number

Returns

Array<T>

public flatten(shallow?: boolean): Array<any>

Wrapped type any.

see

_.flatten

Parameters

  • shallow?: boolean optional

Returns

Array<any>

public foldl(iterator: MemoIterator, memo?: TResult, context?: any): TResult

see

_.reduce

Parameters

  • iterator: MemoIterator
  • memo?: TResult optional
  • context?: any optional

Returns

TResult

public foldr(iterator: MemoIterator, memo?: TResult, context?: any): TResult

see

_.reduceRight

Parameters

  • iterator: MemoIterator
  • memo?: TResult optional
  • context?: any optional

Returns

TResult

public forEach(iterator: ListIterator, context?: any): Array<T>

see

_.each

Parameters

Returns

Array<T>

public forEach(iterator: ObjectIterator, context?: any): Array<T>

see

_.each

Parameters

Returns

Array<T>

public functions(): Array<string>

Wrapped type object.

see

_.functions

Returns

Array<string>

public groupBy(iterator?: ListIterator, context?: any): Dictionary

Wrapped type any[].

see

_.groupBy

Parameters

Returns

Dictionary

public groupBy(iterator: string, context?: any): Dictionary

Wrapped type any[].

see

_.groupBy

Parameters

  • iterator: string
  • context?: any optional

Returns

Dictionary

public has(key: string): boolean

Wrapped type object.

see

_.has

Parameters

  • key: string

Returns

boolean

public head(): T in Underscore<T>

see

_.first

Returns

T in Underscore<T>

public head(n: number): Array<T>

see

_.first

Parameters

  • n: number

Returns

Array<T>

public identity(): any

Wrapped type any.

see

_.identity

Returns

any

public include(value: T in Underscore<T>): boolean

Alias for 'contains'.

see

contains

Parameters

  • value: T in Underscore<T>

Returns

boolean

public indexBy(iterator: ListIterator, context?: any): Dictionary

Wrapped type any[].

see

_.indexBy

Parameters

Returns

Dictionary

public indexBy(iterator: string, context?: any): Dictionary

Wrapped type any[].

see

_.indexBy

Parameters

  • iterator: string
  • context?: any optional

Returns

Dictionary

public indexOf(value: T in Underscore<T>, isSorted?: boolean): number

Wrapped type any[].

see

_.indexOf

Parameters

  • value: T in Underscore<T>
  • isSorted?: boolean optional

Returns

number

public indexOf(value: T in Underscore<T>, startFrom: number): number

see

_.indexOf

Parameters

  • value: T in Underscore<T>
  • startFrom: number

Returns

number

public initial(n?: number): Array<T>

Wrapped type any[].

see

_.initial

Parameters

  • n?: number optional

Returns

Array<T>

public inject(iterator: MemoIterator, memo?: TResult, context?: any): TResult

see

_.reduce

Parameters

  • iterator: MemoIterator
  • memo?: TResult optional
  • context?: any optional

Returns

TResult

public intersection(arrays?: List[]): Array<T>

Wrapped type any[][].

see

_.intersection

Parameters

  • arrays?: List[] optional

Returns

Array<T>

public invert(): any

Wrapped type object.

see

_.invert

Returns

any

public invoke(methodName: string, arguments?: Array<any>): any

Wrapped type any[].

see

_.invoke

Parameters

  • methodName: string
  • arguments?: Array<any> optional

Returns

any

public isArguments(): boolean

Wrapped type object.

see

_.isArguments

Returns

boolean

public isArray(): boolean

Wrapped type object.

see

_.isArray

Returns

boolean

public isBoolean(): boolean

Wrapped type object.

see

_.isBoolean

Returns

boolean

public isDate(): boolean

Wrapped type object.

see

_.isDate

Returns

boolean

public isElement(): boolean

Wrapped type object.

see

_.isElement

Returns

boolean

public isEmpty(): boolean

Wrapped type object.

see

_.isEmpty

Returns

boolean

public isEqual(other: any): boolean

Wrapped type object.

see

_.isEqual

Parameters

  • other: any

Returns

boolean

public isFinite(): boolean

Wrapped type object.

see

_.isFinite

Returns

boolean

public isFunction(): boolean

Wrapped type object.

see

_.isFunction

Returns

boolean

public isNaN(): boolean

Wrapped type object.

see

_.isNaN

Returns

boolean

public isNull(): boolean

Wrapped type object.

see

_.isNull

Returns

boolean

public isNumber(): boolean

Wrapped type object.

see

_.isNumber

Returns

boolean

public isObject(): boolean

Wrapped type object.

see

_.isObject

Returns

boolean

public isRegExp(): boolean

Wrapped type object.

see

_.isRegExp

Returns

boolean

public isString(): boolean

Wrapped type object.

see

_.isString

Returns

boolean

public isUndefined(): boolean

Wrapped type object.

see

_.isUndefined

Returns

boolean

public keys(): Array<string>

Wrapped type object.

see

_.keys

Returns

Array<string>

public last(): T in Underscore<T>

Wrapped type any[].

see

_.last

Returns

T in Underscore<T>

public last(n: number): Array<T>

Wrapped type any[].

see

_.last

Parameters

  • n: number

Returns

Array<T>

public lastIndexOf(value: T in Underscore<T>, from?: number): number

Wrapped type any[].

see

_.lastIndexOf

Parameters

  • value: T in Underscore<T>
  • from?: number optional

Returns

number

public map(iterator: ListIterator, context?: any): Array<TResult>

Wrapped type any[].

see

_.map

Parameters

Returns

Array<TResult>

public map(iterator: ObjectIterator, context?: any): Array<TResult>

Wrapped type any[].

see

_.map

Parameters

Returns

Array<TResult>

public matches(): ListIterator

Wrapped type any[].

see

_.matches

Returns

ListIterator

public max(): number

Wrapped type number[].

see

_.max

Returns

number

public max(iterator: ListIterator, context?: any): T in Underscore<T>

Wrapped type any[].

see

_.max

Parameters

Returns

T in Underscore<T>

public max(iterator?: ListIterator, context?: any): T in Underscore<T>

Wrapped type any[].

see

_.max

Parameters

Returns

T in Underscore<T>

public memoize(hashFn?: (n: any) => string): Function

Wrapped type Function.

see

_.memoize

Parameters

  • hashFn?: (n: any) => string optional

Returns

Function

public methods(): Array<string>

see

_.functions

Returns

Array<string>

public min(): number

Wrapped type number[].

see

_.min

Returns

number

public min(iterator: ListIterator, context?: any): T in Underscore<T>

Wrapped type any[].

see

_.min

Parameters

Returns

T in Underscore<T>

public min(iterator?: ListIterator, context?: any): T in Underscore<T>

Wrapped type any[].

see

_.min

Parameters

Returns

T in Underscore<T>

public mixin()

Wrapped type object.

see

_.mixin

public object(keyValuePairs?: Array<any[]>): any

Wrapped type any[][].

see

_.object

Parameters

  • keyValuePairs?: Array<any[]> optional

Returns

any

public object(values?: any): any

see

_.object

Parameters

  • values?: any optional

Returns

any

public omit(keys?: Array<string>): any

Wrapped type object.

see

_.omit

Parameters

  • keys?: Array<string> optional

Returns

any

public omit(keys: Array<string>): any

Parameters

  • keys: Array<string>

Returns

any

public once(): Function

Wrapped type Function.

see

_.once

Returns

Function

public pairs(): Array<any[]>

Wrapped type object.

see

_.pairs

Returns

Array<any[]>

public partial(arguments?: Array<any>): Function

Wrapped type Function.

see

_.partial

Parameters

  • arguments?: Array<any> optional

Returns

Function

public partition(iterator: ListIterator, context?: any): Array<T[]>

Wrapped type any[].

see

_.partition

Parameters

Returns

Array<T[]>

public pick(keys?: Array<string>): any

Wrapped type object.

see

_.pick

Parameters

  • keys?: Array<string> optional

Returns

any

public pick(keys: Array<string>): any

Parameters

  • keys: Array<string>

Returns

any

public pluck(propertyName: string): Array<any>

Wrapped type any[].

see

_.pluck

Parameters

  • propertyName: string

Returns

Array<any>

public property(): (object: Object) => any

Wrapped type string.

see

_.property

Returns

(object: Object) => any

public random(): number

Wrapped type number.

see

_.random

Returns

number

public random(max: number): number

Wrapped type number.

see

_.random

Parameters

  • max: number

Returns

number

public range(stop: number, step?: number): Array<number>

Wrapped type number.

see

_.range

Parameters

  • stop: number
  • step?: number optional

Returns

Array<number>

public range(): Array<number>

Wrapped type number.

see

_.range

Returns

Array<number>

public reduce(iterator: MemoIterator, memo?: TResult, context?: any): TResult

Wrapped type any[].

see

_.reduce

Parameters

  • iterator: MemoIterator
  • memo?: TResult optional
  • context?: any optional

Returns

TResult

public reduceRight(iterator: MemoIterator, memo?: TResult, context?: any): TResult

Wrapped type any[].

see

_.reduceRight

Parameters

  • iterator: MemoIterator
  • memo?: TResult optional
  • context?: any optional

Returns

TResult

public reject(iterator: ListIterator, context?: any): Array<T>

Wrapped type any[].

see

_.reject

Parameters

Returns

Array<T>

public rest(n?: number): Array<T>

Wrapped type any[].

see

_.rest

Parameters

  • n?: number optional

Returns

Array<T>

public result(property: string): any

Wrapped type object.

see

_.result

Parameters

  • property: string

Returns

any

public sample(n: number): Array<T>

Wrapped type any[].

see

_.sample

Parameters

  • n: number

Returns

Array<T>

public sample(): T

see

_.sample

Returns

T

public select(iterator: ListIterator, context?: any): Array<T>

see

_.filter

Parameters

Returns

Array<T>

public shuffle(): Array<T>

Wrapped type any[].

see

_.shuffle

Returns

Array<T>

public size(): number

Wrapped type any.

see

_.size

Returns

number

public some(iterator?: ListIterator, context?: any): boolean

see

_.any

Parameters

Returns

boolean

public sortBy(iterator?: ListIterator, context?: any): Array<T>

Wrapped type any[].

see

_.sortBy

Parameters

Returns

Array<T>

public sortBy(iterator: string, context?: any): Array<T>

Wrapped type any[].

see

_.sortBy

Parameters

  • iterator: string
  • context?: any optional

Returns

Array<T>

public sortedIndex(value: T in Underscore<T>, iterator?: (x: T) => any, context?: any): number

Wrapped type any[].

see

_.sortedIndex

Parameters

  • value: T in Underscore<T>
  • iterator?: (x: T) => any optional
  • context?: any optional

Returns

number

public tail(n?: number): Array<T>

see

_.rest

Parameters

  • n?: number optional

Returns

Array<T>

public take(): T in Underscore<T>

see

_.first

Returns

T in Underscore<T>

public take(n: number): Array<T>

see

_.first

Parameters

  • n: number

Returns

Array<T>

public tap(interceptor: (...as: any[]) => any): any

Wrapped type object.

see

_.tap

Parameters

  • interceptor: (...as: any[]) => any

Returns

any

public template(data?: any, settings?: TemplateSettings): (...data: any[]) => string

Wrapped type string.

see

_.template

Parameters

Returns

(...data: any[]) => string

public throttle(wait: number, options?: ThrottleSettings): Function

Wrapped type Function.

see

_.throttle

Parameters

Returns

Function

public times(iterator: (n: number) => TResult, context?: any): Array<TResult>

Wrapped type number.

see

_.times

Parameters

  • iterator: (n: number) => TResult
  • context?: any optional

Returns

Array<TResult>

public toArray(): Array<T>

Wrapped type any.

see

_.toArray

Returns

Array<T>

public union(arrays?: List[]): Array<T>

Wrapped type any[][].

see

_.union

Parameters

  • arrays?: List[] optional

Returns

Array<T>

public uniq(isSorted?: boolean, iterator?: ListIterator): Array<T>

Wrapped type any[].

see

_.uniq

Parameters

  • isSorted?: boolean optional
  • iterator?: ListIterator optional

Returns

Array<T>

public uniq(iterator?: ListIterator, context?: any): Array<T>

Wrapped type any[].

see

_.uniq

Parameters

Returns

Array<T>

public unique(isSorted?: boolean, iterator?: ListIterator): Array<T>

see

_.uniq

Parameters

  • isSorted?: boolean optional
  • iterator?: ListIterator optional

Returns

Array<T>

public unique(iterator?: ListIterator, context?: any): Array<T>

see

_.uniq

Parameters

Returns

Array<T>

public uniqueId(): string

Wrapped type string.

see

_.uniqueId

Returns

string

public value(): TResult

Wrapped type any.

see

_.value

Returns

TResult

public values(): Array<T>

Wrapped type object.

see

_.values

Returns

Array<T>

public where(properties: U): Array<T>

Wrapped type any[].

see

_.where

Parameters

  • properties: U

Returns

Array<T>

public without(values?: Array<T>): Array<T>

Wrapped type any[].

see

_.without

Parameters

  • values?: Array<T> optional

Returns

Array<T>

public wrap(wrapper: Function): () => Function

Wrapped type Function.

see

_.wrap

Parameters

  • wrapper: Function

Returns

() => Function

public zip(arrays?: Array<any[]>): Array<any[]>

Wrapped type any[][].

see

_.zip

Parameters

  • arrays?: Array<any[]> optional

Returns

Array<any[]>