@types/lodash
- Version 4.17.13
- Published
- 868 kB
- No dependencies
- MIT license
Install
npm i @types/lodash
yarn add @types/lodash
pnpm add @types/lodash
Overview
TypeScript definitions for lodash
Index
Interfaces
Type Aliases
- AnyKindOfDictionary
- ArrayIterator
- AssignCustomizer
- CloneDeepWithCustomizer
- CloneWithCustomizer
- Comparator
- Comparator2
- CondPairNullary
- CondPairUnary
- ConformsPredicateObject
- DictionaryIteratee
- DictionaryIterator
- DictionaryIteratorTypeGuard
- EmptyObject
- EmptyObjectOf
- ExpChain
- Falsey
- Flat
- Function0
- Function1
- Function2
- Function3
- Function4
- FunctionBase
- GetFieldType
- GetFieldTypeOfArrayLikeByKey
- GetFieldTypeOfNarrowed
- GetFieldTypeOfNarrowedByDotPath
- GetFieldTypeOfNarrowedByKey
- GetFieldTypeOfNarrowedByLcKR
- GetFieldTypeOfNarrowedByLKR
- GetFieldTypeOfObject
- GetFieldTypeOfPrimitive
- GetFieldTypeOfStringByKey
- ImpChain
- IsEqualCustomizer
- isMatchWithCustomizer
- IterateeShorthand
- List
- ListIteratee
- ListIterateeCustom
- ListIterator
- ListIteratorTypeGuard
- LoDashExplicitArrayWrapper
- LoDashExplicitNillableArrayWrapper
- LoDashExplicitNillableObjectWrapper
- LoDashExplicitNumberArrayWrapper
- LoDashExplicitObjectWrapper
- LoDashExplicitStringWrapper
- LoDashImplicitArrayWrapper
- LoDashImplicitNillableArrayWrapper
- LoDashImplicitNillableObjectWrapper
- LoDashImplicitNumberArrayWrapper
- LoDashImplicitObjectWrapper
- LoDashImplicitStringWrapper
- Many
- MemoIterator
- MemoIteratorCapped
- MemoIteratorCappedRight
- MemoListIterator
- MemoObjectIterator
- MemoVoidArrayIterator
- MemoVoidDictionaryIterator
- MemoVoidIterator
- MemoVoidIteratorCapped
- MergeWithCustomizer
- NotVoid
- NumericDictionaryIteratee
- NumericDictionaryIterateeCustom
- NumericDictionaryIterator
- ObjectIteratee
- ObjectIterateeCustom
- ObjectIterator
- ObjectIteratorTypeGuard
- Omit
- PartialObject
- PartialShallow
- PropertyName
- PropertyPath
- ReplaceFunction
- SetWithCustomizer
- StringIterator
- StringToNumber
- ThrottleSettingsLeading
- Truthy
- TupleIterator
- ValueIteratee
- ValueIterateeCustom
- ValueIteratorTypeGuard
- ValueKeyIteratee
- ValueKeyIterateeTypeGuard
Interfaces
interface Collection
interface Collection<T> {}
method pop
pop: () => T | undefined;
method push
push: (...items: T[]) => this;
method shift
shift: () => T | undefined;
method sort
sort: (compareFn?: (a: T, b: T) => number) => this;
method splice
splice: (start: number, deleteCount?: number, ...items: T[]) => this;
method unshift
unshift: (...items: T[]) => this;
interface Collection
interface Collection<T> extends LoDashImplicitWrapper<T[]> {}
interface Collection
interface Collection<T> {}
method chunk
chunk: (size?: number) => Collection<T[]>;
See Also
_.chunk
interface Collection
interface Collection<T> {}
method compact
compact: () => Collection<Truthy<T>>;
See Also
_.compact
interface Collection
interface Collection<T> {}
method concat
concat: (...values: Array<Many<T>>) => Collection<T>;
See Also
_.concat
interface Collection
interface Collection<T> {}
method difference
difference: (...values: Array<List<T>>) => Collection<T>;
See Also
_.difference
interface Collection
interface Collection<T> {}
method differenceBy
differenceBy: { <T2>(values1: List<T2>, iteratee?: ValueIteratee<T | T2>): Collection<T>; (...values: (List<unknown> | ValueIteratee<T>)[]): Collection<T>;};
See Also
_.differenceBy
interface Collection
interface Collection<T> {}
method differenceWith
differenceWith: { <T2>(values: List<T2>, comparator: Comparator2<T, T2>): Collection<T>; <T2, T3, T4>( ...values: (List<unknown> | Comparator2<T, never>)[] ): Collection<T>;};
See Also
_.differenceWith
interface Collection
interface Collection<T> {}
method drop
drop: (n?: number) => Collection<T>;
See Also
_.drop
interface Collection
interface Collection<T> {}
method dropRight
dropRight: (n?: number) => Collection<T>;
See Also
_.dropRight
interface Collection
interface Collection<T> {}
method dropRightWhile
dropRightWhile: (predicate?: ListIteratee<T>) => Collection<T>;
See Also
_.dropRightWhile
interface Collection
interface Collection<T> {}
method dropWhile
dropWhile: (predicate?: ListIteratee<T>) => Collection<T>;
See Also
_.dropWhile
interface Collection
interface Collection<T> {}
method fill
fill: <U>(value: U, start?: number, end?: number) => Collection<T | U>;
See Also
_.fill
interface Collection
interface Collection<T> {}
method findIndex
findIndex: ( predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number) => number;
See Also
_.findIndex
interface Collection
interface Collection<T> {}
method findLastIndex
findLastIndex: ( predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number) => number;
See Also
_.findLastIndex
interface Collection
interface Collection<T> {}
method first
first: () => T | undefined;
See Also
_.first
interface Collection
interface Collection<T> {}
method flatten
flatten: () => T extends Many<infer U> ? Collection<U> : Collection<T>;
See Also
_.flatten
interface Collection
interface Collection<T> {}
method flattenDeep
flattenDeep: () => T extends ListOfRecursiveArraysOrValues<infer U> ? Collection<Flat<U>> : Collection<T>;
See Also
_.flattenDeep
interface Collection
interface Collection<T> {}
method flattenDepth
flattenDepth: (depth?: number) => Collection<T>;
See Also
_.flattenDepth
interface Collection
interface Collection<T> {}
method fromPairs
fromPairs: () => Object<Dictionary<T extends [PropertyName, infer U] ? U : any>>;
See Also
_.fromPairs
interface Collection
interface Collection<T> {}
method head
head: () => T | undefined;
See Also
_.head
interface Collection
interface Collection<T> {}
method indexOf
indexOf: (value: T, fromIndex?: number) => number;
See Also
_.indexOf
interface Collection
interface Collection<T> {}
method initial
initial: () => Collection<T>;
See Also
_.initial
interface Collection
interface Collection<T> {}
method intersection
intersection: (...arrays: Array<List<T> | null | undefined>) => Collection<T>;
See Also
_.intersection
interface Collection
interface Collection<T> {}
method intersectionBy
intersectionBy: { <T2>(values: List<T2>, iteratee: ValueIteratee<T | T2>): Collection<T>; (...values: (List<unknown> | ValueIteratee<T>)[]): Collection<T>;};
See Also
_.intersectionBy
interface Collection
interface Collection<T> {}
method intersectionWith
intersectionWith: { <T2>(values: List<T2>, comparator: Comparator2<T, T2>): Collection<T>; (...values: (List<unknown> | Comparator2<T, never>)[]): Collection<T>;};
See Also
_.intersectionWith
interface Collection
interface Collection<T> {}
method join
join: (separator?: string) => string;
See Also
_.join
interface Collection
interface Collection<T> {}
method last
last: () => T | undefined;
See Also
_.last
interface Collection
interface Collection<T> {}
method lastIndexOf
lastIndexOf: (value: T, fromIndex?: true | number) => number;
See Also
_.lastIndexOf
interface Collection
interface Collection<T> {}
method nth
nth: (n?: number) => T | undefined;
See Also
_.nth
interface Collection
interface Collection<T> {}
method pull
pull: (...values: T[]) => Collection<T>;
See Also
_.pull
interface Collection
interface Collection<T> {}
method pullAll
pullAll: (values?: List<T>) => Collection<T>;
See Also
_.pullAll
interface Collection
interface Collection<T> {}
method pullAllBy
pullAllBy: <T2>( values?: List<T2>, iteratee?: ValueIteratee<T | T2>) => Collection<T>;
See Also
_.pullAllBy
interface Collection
interface Collection<T> {}
method pullAllWith
pullAllWith: <T2>( values?: List<T2>, comparator?: Comparator2<T, T2>) => Collection<T>;
See Also
_.pullAllWith
interface Collection
interface Collection<T> {}
method pullAt
pullAt: (...indexes: Array<Many<number>>) => Collection<T>;
See Also
_.pullAt
interface Collection
interface Collection<T> {}
method remove
remove: (predicate?: ListIteratee<T>) => Collection<T>;
See Also
_.remove
interface Collection
interface Collection<T> {}
method slice
slice: (start?: number, end?: number) => Collection<T>;
See Also
_.slice
interface Collection
interface Collection<T> {}
method sortedIndex
sortedIndex: { (value: T): number; (value: T): number };
See Also
_.sortedIndex
interface Collection
interface Collection<T> {}
method sortedIndex
sortedIndex: { (value: T): number; (value: T): number };
See Also
_.sortedIndex
interface Collection
interface Collection<T> {}
method sortedIndexBy
sortedIndexBy: (value: T, iteratee?: ValueIteratee<T>) => number;
See Also
_.sortedIndexBy
interface Collection
interface Collection<T> {}
method sortedIndexOf
sortedIndexOf: (value: T) => number;
See Also
_.sortedIndexOf
interface Collection
interface Collection<T> {}
method sortedLastIndex
sortedLastIndex: (value: T) => number;
See Also
_.sortedLastIndex
interface Collection
interface Collection<T> {}
method sortedLastIndexBy
sortedLastIndexBy: (value: T, iteratee: ValueIteratee<T>) => number;
See Also
_.sortedLastIndexBy
interface Collection
interface Collection<T> {}
method sortedLastIndexOf
sortedLastIndexOf: (value: T) => number;
See Also
_.sortedLastIndexOf
interface Collection
interface Collection<T> {}
method sortedUniq
sortedUniq: () => Collection<T>;
See Also
_.sortedUniq
interface Collection
interface Collection<T> {}
method sortedUniqBy
sortedUniqBy: (iteratee: ValueIteratee<T>) => Collection<T>;
See Also
_.sortedUniqBy
interface Collection
interface Collection<T> {}
method tail
tail: () => Collection<T>;
See Also
_.tail
interface Collection
interface Collection<T> {}
method take
take: (n?: number) => Collection<T>;
See Also
_.take
interface Collection
interface Collection<T> {}
method takeRight
takeRight: (n?: number) => Collection<T>;
See Also
_.takeRight
interface Collection
interface Collection<T> {}
method takeRightWhile
takeRightWhile: (predicate?: ListIteratee<T>) => Collection<T>;
See Also
_.takeRightWhile
interface Collection
interface Collection<T> {}
method takeWhile
takeWhile: (predicate?: ListIteratee<T>) => Collection<T>;
See Also
_.takeWhile
interface Collection
interface Collection<T> {}
method union
union: (...arrays: Array<List<T> | null | undefined>) => Collection<T>;
See Also
_.union
interface Collection
interface Collection<T> {}
method unionBy
unionBy: { ( arrays2: List<T> | null | undefined, iteratee?: ValueIteratee<T> ): Collection<T>; (...iteratee: (List<T> | ValueIteratee<T>)[]): Collection<T>;};
See Also
_.unionBy
interface Collection
interface Collection<T> {}
method unionWith
unionWith: { ( arrays2: List<T> | null | undefined, comparator?: Comparator<T> ): Collection<T>; (...comparator: (List<T> | Comparator<T>)[]): Collection<T>;};
See Also
_.unionWith
interface Collection
interface Collection<T> {}
method uniq
uniq: () => Collection<T>;
See Also
_.uniq
interface Collection
interface Collection<T> {}
method uniqBy
uniqBy: (iteratee: ValueIteratee<T>) => Collection<T>;
See Also
_.uniqBy
interface Collection
interface Collection<T> {}
method uniqWith
uniqWith: (comparator?: Comparator<T>) => Collection<T>;
See Also
_.uniqWith
interface Collection
interface Collection<T> {}
method unzip
unzip: () => T extends List<infer U> ? Collection<U[]> : unknown;
See Also
_.unzip
interface Collection
interface Collection<T> {}
method unzipWith
unzipWith: { <TResult>( iteratee: ( ...values: (T extends List<infer U> ? U : unknown)[] ) => TResult ): Collection<TResult>; (): T extends List<infer U> ? Collection<U[]> : unknown;};
See Also
_.unzipWith
interface Collection
interface Collection<T> {}
method without
without: (...values: T[]) => Collection<T>;
See Also
_.without
interface Collection
interface Collection<T> {}
method xor
xor: (...arrays: Array<List<T> | null | undefined>) => Collection<T>;
See Also
_.xor
interface Collection
interface Collection<T> {}
method xorBy
xorBy: { ( arrays2: List<T> | null | undefined, iteratee?: ValueIteratee<T> ): Collection<T>; (...iteratee: (List<T> | ValueIteratee<T>)[]): Collection<T>;};
See Also
_.xorBy
interface Collection
interface Collection<T> {}
method xorWith
xorWith: { ( arrays2: List<T> | null | undefined, comparator?: Comparator<T> ): Collection<T>; (...comparator: (List<T> | Comparator<T>)[]): Collection<T>;};
See Also
_.xorWith
interface Collection
interface Collection<T> {}
method zip
zip: { <T2>(arrays2: List<T2>): Collection<[T | undefined, T2 | undefined]>; (...arrays: List<T>[]): Collection<T[]>;};
See Also
_.zip
interface Collection
interface Collection<T> {}
method zipObject
zipObject: { <U>(values: List<U>): Object<Dictionary<U>>; (): Object<Dictionary<undefined>>;};
See Also
_.zipObject
interface Collection
interface Collection<T> {}
method zipObjectDeep
zipObjectDeep: (values?: List<any>) => Object<object>;
See Also
_.zipObjectDeep
interface Collection
interface Collection<T> {}
method zipWith
zipWith: { <T2, TResult>( arrays2: List<T2>, iteratee: (value1: T, value2: T2) => TResult ): Collection<TResult>; <T2, T3, TResult>( arrays2: List<T2>, arrays3: List<T3>, iteratee: (value1: T, value2: T2, value3: T3) => TResult ): Collection<TResult>; <TResult>( ...iteratee: (List<T> | ((...group: T[]) => TResult))[] ): Collection<TResult>;};
See Also
_.zipWith
interface Collection
interface Collection<T> {}
method countBy
countBy: (iteratee?: ValueIteratee<T>) => Object<Dictionary<number>>;
See Also
_.countBy
interface Collection
interface Collection<T> {}
property each
each: Collection<T>['forEach'];
See Also
_.each
interface Collection
interface Collection<T> {}
property eachRight
eachRight: Collection<T>['forEachRight'];
See Also
_.eachRight
interface Collection
interface Collection<T> {}
method every
every: (predicate?: ListIterateeCustom<T, boolean>) => boolean;
See Also
_.every
interface Collection
interface Collection<T> {}
method filter
filter: { <S extends T>(predicate: ListIteratorTypeGuard<T, S>): Collection<S>; (predicate?: ListIterateeCustom<T, boolean>): Collection<T>;};
See Also
_.filter
interface Collection
interface Collection<T> {}
method find
find: { <S extends T>(predicate: ListIteratorTypeGuard<T, S>, fromIndex?: number): | S | undefined; (predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number): T;};
See Also
_.find
interface Collection
interface Collection<T> {}
method findLast
findLast: { <S extends T>(predicate: ListIteratorTypeGuard<T, S>, fromIndex?: number): | S | undefined; (predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number): T;};
See Also
_.findLast
interface Collection
interface Collection<T> {}
method flatMap
flatMap: { <TResult = any>( iteratee: ListIterator<T, Many<TResult>> | PropertyName ): Collection<TResult>; (iteratee: object | [PropertyName, any]): Collection<boolean>; (): T extends Many<infer U> ? Collection<U> : Collection<T>;};
See Also
_.flatMap
interface Collection
interface Collection<T> {}
method flatMapDeep
flatMapDeep: { <TResult = any>( iteratee: | ListIterator<T, ListOfRecursiveArraysOrValues<TResult> | TResult> | PropertyName ): Collection<TResult>; (iteratee: object | [PropertyName, any]): Collection<boolean>; (): Collection<T>;};
See Also
_.flatMapDeep
interface Collection
interface Collection<T> {}
method flatMapDepth
flatMapDepth: { <TResult = any>( iteratee: | ListIterator<T, ListOfRecursiveArraysOrValues<TResult> | TResult> | PropertyName, depth?: number ): Collection<TResult>; ( iteratee: object | [PropertyName, any], depth?: number ): Collection<boolean>; (depth?: number): Collection<T>;};
See Also
_.flatMapDepth
interface Collection
interface Collection<T> {}
method forEach
forEach: (iteratee?: ListIterator<T, any>) => Collection<T>;
See Also
_.forEach
interface Collection
interface Collection<T> {}
method forEachRight
forEachRight: (iteratee?: ListIterator<T, any>) => Collection<T>;
See Also
_.forEachRight
interface Collection
interface Collection<T> {}
method groupBy
groupBy: (iteratee?: ValueIteratee<T>) => Object<Dictionary<T[]>>;
See Also
_.groupBy
interface Collection
interface Collection<T> {}
method includes
includes: (target: T, fromIndex?: number) => boolean;
See Also
_.includes
interface Collection
interface Collection<T> {}
method keyBy
keyBy: ( iteratee?: ValueIterateeCustom<T, PropertyName>) => Object<Dictionary<T>>;
See Also
_.keyBy
interface Collection
interface Collection<T> {}
method map
map: { <K extends keyof T>(key: K): Collection<T[K]>; <TResult>(iteratee: ListIterator<T, TResult>): Collection<TResult>; (iteratee: PropertyName): Collection<any>; (iteratee: object | [PropertyName, any]): Collection<boolean>; (): Collection<T>;};
See Also
_.map
interface Collection
interface Collection<T> {}
method orderBy
orderBy: ( iteratees?: Many< ListIterator<T, NotVoid> | PropertyName | PartialShallow<T> >, orders?: Many<boolean | 'asc' | 'desc'>) => Collection<T>;
See Also
_.orderBy
interface Collection
interface Collection<T> {}
method partition
partition: { <U extends T>(callback: ValueIteratorTypeGuard<T, U>): LoDashImplicitWrapper< [U[], Array<Exclude<T, U>>] >; (callback: ValueIteratee<T>): LoDashImplicitWrapper<[T[], T[]]>;};
See Also
_.partition
interface Collection
interface Collection<T> {}
method reduce
reduce: { <TResult>( callback: MemoListIterator<T, TResult, List<T>>, accumulator: TResult ): TResult; (callback: MemoListIterator<T, T, List<T>>): T;};
See Also
_.reduce
interface Collection
interface Collection<T> {}
method reduceRight
reduceRight: { <TResult>( callback: MemoListIterator<T, TResult, List<T>>, accumulator: TResult ): TResult; (callback: MemoListIterator<T, T, List<T>>): T;};
See Also
_.reduceRight
interface Collection
interface Collection<T> {}
method reject
reject: (predicate?: ListIterateeCustom<T, boolean>) => Collection<T>;
See Also
_.reject
interface Collection
interface Collection<T> {}
method sample
sample: () => T | undefined;
See Also
_.sample
interface Collection
interface Collection<T> {}
method sampleSize
sampleSize: (n?: number) => Collection<T>;
See Also
_.sampleSize
interface Collection
interface Collection<T> {}
method shuffle
shuffle: () => Collection<T>;
See Also
_.shuffle
interface Collection
interface Collection<T> {}
method some
some: (predicate?: ListIterateeCustom<T, boolean>) => boolean;
See Also
_.some
interface Collection
interface Collection<T> {}
method sortBy
sortBy: (...iteratees: Array<Many<ListIteratee<T>>>) => Collection<T>;
See Also
_.sortBy
interface Collection
interface Collection<T> {}
method castArray
castArray: () => Collection<T>;
See Also
_.castArray
interface Collection
interface Collection<T> {}
method toArray
toArray: () => Collection<T>;
See Also
_.toArray
interface Collection
interface Collection<T> {}
method max
max: () => T | undefined;
See Also
_.max
interface Collection
interface Collection<T> {}
method maxBy
maxBy: (iteratee?: ValueIteratee<T>) => T | undefined;
See Also
_.maxBy
interface Collection
interface Collection<T> {}
method meanBy
meanBy: (iteratee?: ValueIteratee<T>) => number;
See Also
_.meanBy
interface Collection
interface Collection<T> {}
method min
min: () => T | undefined;
See Also
_.min
interface Collection
interface Collection<T> {}
method minBy
minBy: (iteratee?: ValueIteratee<T>) => T | undefined;
See Also
_.minBy
interface Collection
interface Collection<T> {}
method sumBy
sumBy: (iteratee?: string | ((value: T) => number)) => number;
See Also
_.sumBy
interface Collection
interface Collection<T> {}
method at
at: (...props: PropertyPath[]) => Collection<T>;
See Also
_.at
interface Collection
interface Collection<T> {}
method get
get: { (path: number): T; <TDefault>(path: number, defaultValue: TDefault): T | TDefault;};
See Also
_.get
interface Collection
interface Collection<T> {}
method invertBy
invertBy: (iteratee?: ValueIteratee<T>) => Object<Dictionary<string[]>>;
See Also
_.invertBy
interface Collection
interface Collection<T> {}
method mapKeys
mapKeys: (iteratee?: ListIteratee<T>) => Object<Dictionary<T>>;
See Also
_.mapKeys
interface Collection
interface Collection<T> {}
method mapValues
mapValues: { <TResult>(callback: ArrayIterator<T, TResult>): NumericDictionary<TResult>; <TKey extends keyof T>(iteratee: TKey): Object<Dictionary<T[TKey]>>; (iteratee: object): Object<Dictionary<boolean>>; (iteratee: string): Object<Dictionary<any>>; (): Object<Dictionary<T>>;};
See Also
_.mapValues
interface Collection
interface Collection<T> {}
method omit
omit: (...paths: Array<Many<PropertyName>>) => Collection<T>;
See Also
_.omit
interface Collection
interface Collection<T> {}
method omitBy
omitBy: (predicate?: ValueKeyIteratee<T>) => Object<Dictionary<T>>;
See Also
_.omitBy
interface Collection
interface Collection<T> {}
method pickBy
pickBy: { <S extends T>(predicate: ValueKeyIterateeTypeGuard<T, S>): Object< Dictionary<S> >; (predicate?: ValueKeyIteratee<T>): Object<Dictionary<T>>;};
See Also
_.pickBy
interface Collection
interface Collection<T> {}
method transform
transform: { <TResult>( iteratee: MemoVoidArrayIterator<T, TResult>, accumulator?: TResult ): ImpChain<TResult>; (): Collection<any>;};
See Also
_.transform
interface Collection
interface Collection<T> {}
method chain
chain: () => CollectionChain<T>;
See Also
_.chain
interface Collection
interface Collection<T> {}
method iteratee
iteratee: () => Function<(o: object) => boolean>;
See Also
_.iteratee
interface Collection
interface Collection<T> {}
method over
over: <TResult>( ...iteratees: Many<(...args: any[]) => TResult>[]) => Function<(...args: any[]) => TResult[]>;
See Also
_.over
interface Collection
interface Collection<T> {}
method overEvery
overEvery: <TArgs>( ...iteratees: Many<(...args: TArgs[]) => boolean>[]) => Function<(...args: TArgs[]) => boolean>;
See Also
_.overEvery
interface Collection
interface Collection<T> {}
method overSome
overSome: <TArgs>( ...iteratees: Many<(...args: TArgs[]) => boolean>[]) => Function<(...args: TArgs[]) => boolean>;
See Also
_.overSome
interface CollectionChain
interface CollectionChain<T> {}
method pop
pop: () => ExpChain<T | undefined>;
method push
push: (...items: T[]) => this;
method shift
shift: () => ExpChain<T | undefined>;
method sort
sort: (compareFn?: (a: T, b: T) => number) => this;
method splice
splice: (start: number, deleteCount?: number, ...items: T[]) => this;
method unshift
unshift: (...items: T[]) => this;
interface CollectionChain
interface CollectionChain<T> extends LoDashExplicitWrapper<T[]> {}
interface CollectionChain
interface CollectionChain<T> {}
method chunk
chunk: (size?: number) => CollectionChain<T[]>;
See Also
_.chunk
interface CollectionChain
interface CollectionChain<T> {}
method compact
compact: () => CollectionChain<Truthy<T>>;
See Also
_.compact
interface CollectionChain
interface CollectionChain<T> {}
method concat
concat: (...values: Array<Many<T>>) => CollectionChain<T>;
See Also
_.concat
interface CollectionChain
interface CollectionChain<T> {}
method difference
difference: (...values: Array<List<T>>) => CollectionChain<T>;
See Also
_.difference
interface CollectionChain
interface CollectionChain<T> {}
method differenceBy
differenceBy: { <T2>( values1: List<T2>, iteratee?: ValueIteratee<T | T2> ): CollectionChain<T>; (...values: (List<unknown> | ValueIteratee<T>)[]): CollectionChain<T>;};
See Also
_.differenceBy
interface CollectionChain
interface CollectionChain<T> {}
method differenceWith
differenceWith: { <T2>(values: List<T2>, comparator: Comparator2<T, T2>): CollectionChain<T>; <T2, T3, T4>( ...values: (List<unknown> | Comparator2<T, never>)[] ): CollectionChain<T>;};
See Also
_.differenceWith
interface CollectionChain
interface CollectionChain<T> {}
method drop
drop: (n?: number) => CollectionChain<T>;
See Also
_.drop
interface CollectionChain
interface CollectionChain<T> {}
method dropRight
dropRight: (n?: number) => CollectionChain<T>;
See Also
_.dropRight
interface CollectionChain
interface CollectionChain<T> {}
method dropRightWhile
dropRightWhile: (predicate?: ListIteratee<T>) => CollectionChain<T>;
See Also
_.dropRightWhile
interface CollectionChain
interface CollectionChain<T> {}
method dropWhile
dropWhile: (predicate?: ListIteratee<T>) => CollectionChain<T>;
See Also
_.dropWhile
interface CollectionChain
interface CollectionChain<T> {}
method fill
fill: <U>(value: U, start?: number, end?: number) => CollectionChain<T | U>;
See Also
_.fill
interface CollectionChain
interface CollectionChain<T> {}
method findIndex
findIndex: ( predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number) => PrimitiveChain<number>;
See Also
_.findIndex
interface CollectionChain
interface CollectionChain<T> {}
method findLastIndex
findLastIndex: ( predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number) => PrimitiveChain<number>;
See Also
_.findLastIndex
interface CollectionChain
interface CollectionChain<T> {}
method first
first: () => ExpChain<T | undefined>;
See Also
_.first
interface CollectionChain
interface CollectionChain<T> {}
method flatten
flatten: () => T extends Many<infer U> ? CollectionChain<U> : CollectionChain<T>;
See Also
_.flatten
interface CollectionChain
interface CollectionChain<T> {}
method flattenDeep
flattenDeep: () => T extends ListOfRecursiveArraysOrValues<infer U> ? CollectionChain<Flat<U>> : CollectionChain<T>;
See Also
_.flattenDeep
interface CollectionChain
interface CollectionChain<T> {}
method flattenDepth
flattenDepth: (depth?: number) => CollectionChain<T>;
See Also
_.flattenDepth
interface CollectionChain
interface CollectionChain<T> {}
method fromPairs
fromPairs: () => ObjectChain< Dictionary<T extends [PropertyName, infer U] ? U : any>>;
See Also
_.fromPairs
interface CollectionChain
interface CollectionChain<T> {}
method head
head: () => ExpChain<T | undefined>;
See Also
_.head
interface CollectionChain
interface CollectionChain<T> {}
method indexOf
indexOf: (value: T, fromIndex?: number) => PrimitiveChain<number>;
See Also
_.indexOf
interface CollectionChain
interface CollectionChain<T> {}
method initial
initial: () => CollectionChain<T>;
See Also
_.initial
interface CollectionChain
interface CollectionChain<T> {}
method intersection
intersection: ( ...arrays: Array<List<T> | null | undefined>) => CollectionChain<T>;
See Also
_.intersection
interface CollectionChain
interface CollectionChain<T> {}
method intersectionBy
intersectionBy: { <T2>(values: List<T2>, iteratee: ValueIteratee<T | T2>): CollectionChain<T>; (...values: (List<unknown> | ValueIteratee<T>)[]): CollectionChain<T>;};
See Also
_.intersectionBy
interface CollectionChain
interface CollectionChain<T> {}
method intersectionWith
intersectionWith: { <T2>(values: List<T2>, comparator: Comparator2<T, T2>): CollectionChain<T>; (...values: (List<unknown> | Comparator2<T, never>)[]): CollectionChain<T>;};
See Also
_.intersectionWith
interface CollectionChain
interface CollectionChain<T> {}
method join
join: (separator?: string) => StringChain;
See Also
_.join
interface CollectionChain
interface CollectionChain<T> {}
method last
last: () => ExpChain<T | undefined>;
See Also
_.last
interface CollectionChain
interface CollectionChain<T> {}
method lastIndexOf
lastIndexOf: (value: T, fromIndex?: true | number) => PrimitiveChain<number>;
See Also
_.lastIndexOf
interface CollectionChain
interface CollectionChain<T> {}
method nth
nth: (n?: number) => ExpChain<T | undefined>;
See Also
_.nth
interface CollectionChain
interface CollectionChain<T> {}
method pull
pull: (...values: T[]) => CollectionChain<T>;
See Also
_.pull
interface CollectionChain
interface CollectionChain<T> {}
method pullAll
pullAll: (values?: List<T>) => CollectionChain<T>;
See Also
_.pullAll
interface CollectionChain
interface CollectionChain<T> {}
method pullAllBy
pullAllBy: <T2>( values?: List<T2>, iteratee?: ValueIteratee<T | T2>) => CollectionChain<T>;
See Also
_.pullAllBy
interface CollectionChain
interface CollectionChain<T> {}
method pullAllWith
pullAllWith: <T2>( values?: List<T2>, comparator?: Comparator2<T, T2>) => CollectionChain<T>;
See Also
_.pullAllWith
interface CollectionChain
interface CollectionChain<T> {}
method pullAt
pullAt: (...indexes: Array<Many<number>>) => CollectionChain<T>;
See Also
_.pullAt
interface CollectionChain
interface CollectionChain<T> {}
method remove
remove: (predicate?: ListIteratee<T>) => CollectionChain<T>;
See Also
_.remove
interface CollectionChain
interface CollectionChain<T> {}
method slice
slice: (start?: number, end?: number) => CollectionChain<T>;
See Also
_.slice
interface CollectionChain
interface CollectionChain<T> {}
method sortedIndex
sortedIndex: { (value: T): PrimitiveChain<number>; (value: T): PrimitiveChain<number>;};
See Also
_.sortedIndex
interface CollectionChain
interface CollectionChain<T> {}
method sortedIndex
sortedIndex: { (value: T): PrimitiveChain<number>; (value: T): PrimitiveChain<number>;};
See Also
_.sortedIndex
interface CollectionChain
interface CollectionChain<T> {}
method sortedIndexBy
sortedIndexBy: (value: T, iteratee?: ValueIteratee<T>) => PrimitiveChain<number>;
See Also
_.sortedIndexBy
interface CollectionChain
interface CollectionChain<T> {}
method sortedIndexOf
sortedIndexOf: (value: T) => PrimitiveChain<number>;
See Also
_.sortedIndexOf
interface CollectionChain
interface CollectionChain<T> {}
method sortedLastIndex
sortedLastIndex: (value: T) => PrimitiveChain<number>;
See Also
_.sortedLastIndex
interface CollectionChain
interface CollectionChain<T> {}
method sortedLastIndexBy
sortedLastIndexBy: ( value: T, iteratee: ValueIteratee<T>) => PrimitiveChain<number>;
See Also
_.sortedLastIndexBy
interface CollectionChain
interface CollectionChain<T> {}
method sortedLastIndexOf
sortedLastIndexOf: (value: T) => PrimitiveChain<number>;
See Also
_.sortedLastIndexOf
interface CollectionChain
interface CollectionChain<T> {}
method sortedUniq
sortedUniq: () => CollectionChain<T>;
See Also
_.sortedUniq
interface CollectionChain
interface CollectionChain<T> {}
method sortedUniqBy
sortedUniqBy: (iteratee: ValueIteratee<T>) => CollectionChain<T>;
See Also
_.sortedUniqBy
interface CollectionChain
interface CollectionChain<T> {}
method tail
tail: () => CollectionChain<T>;
See Also
_.tail
interface CollectionChain
interface CollectionChain<T> {}
method take
take: (n?: number) => CollectionChain<T>;
See Also
_.take
interface CollectionChain
interface CollectionChain<T> {}
method takeRight
takeRight: (n?: number) => CollectionChain<T>;
See Also
_.takeRight
interface CollectionChain
interface CollectionChain<T> {}
method takeRightWhile
takeRightWhile: (predicate?: ListIteratee<T>) => CollectionChain<T>;
See Also
_.takeRightWhile
interface CollectionChain
interface CollectionChain<T> {}
method takeWhile
takeWhile: (predicate?: ListIteratee<T>) => CollectionChain<T>;
See Also
_.takeWhile
interface CollectionChain
interface CollectionChain<T> {}
method union
union: (...arrays: Array<List<T> | null | undefined>) => CollectionChain<T>;
See Also
_.union
interface CollectionChain
interface CollectionChain<T> {}
method unionBy
unionBy: { ( arrays2: List<T> | null | undefined, iteratee?: ValueIteratee<T> ): CollectionChain<T>; (...iteratee: (List<T> | ValueIteratee<T>)[]): CollectionChain<T>;};
See Also
_.unionBy
interface CollectionChain
interface CollectionChain<T> {}
method unionWith
unionWith: { ( arrays2: List<T> | null | undefined, comparator?: Comparator<T> ): CollectionChain<T>; (...comparator: (List<T> | Comparator<T>)[]): CollectionChain<T>;};
See Also
_.unionWith
interface CollectionChain
interface CollectionChain<T> {}
method uniq
uniq: () => CollectionChain<T>;
See Also
_.uniq
interface CollectionChain
interface CollectionChain<T> {}
method uniqBy
uniqBy: (iteratee: ValueIteratee<T>) => CollectionChain<T>;
See Also
_.uniqBy
interface CollectionChain
interface CollectionChain<T> {}
method uniqWith
uniqWith: (comparator?: Comparator<T>) => CollectionChain<T>;
See Also
_.uniqWith
interface CollectionChain
interface CollectionChain<T> {}
method unzip
unzip: () => T extends List<infer U> ? CollectionChain<U[]> : unknown;
See Also
_.unzip
interface CollectionChain
interface CollectionChain<T> {}
method unzipWith
unzipWith: { <TResult>( iteratee: ( ...values: (T extends List<infer U> ? U : unknown)[] ) => TResult ): CollectionChain<TResult>; (): T extends List<infer U> ? CollectionChain<U[]> : unknown;};
See Also
_.unzipWith
interface CollectionChain
interface CollectionChain<T> {}
method without
without: (...values: T[]) => CollectionChain<T>;
See Also
_.without
interface CollectionChain
interface CollectionChain<T> {}
method xor
xor: (...arrays: Array<List<T> | null | undefined>) => CollectionChain<T>;
See Also
_.xor
interface CollectionChain
interface CollectionChain<T> {}
method xorBy
xorBy: { ( arrays2: List<T> | null | undefined, iteratee?: ValueIteratee<T> ): CollectionChain<T>; (...iteratee: (List<T> | ValueIteratee<T>)[]): CollectionChain<T>;};
See Also
_.xorBy
interface CollectionChain
interface CollectionChain<T> {}
method xorWith
xorWith: { ( arrays2: List<T> | null | undefined, comparator?: Comparator<T> ): CollectionChain<T>; (...comparator: (List<T> | Comparator<T>)[]): CollectionChain<T>;};
See Also
_.xorWith
interface CollectionChain
interface CollectionChain<T> {}
method zip
zip: { <T2>(arrays2: List<T2>): CollectionChain<[T | undefined, T2 | undefined]>; (...arrays: List<T>[]): CollectionChain<T[]>;};
See Also
_.zip
interface CollectionChain
interface CollectionChain<T> {}
method zipObject
zipObject: { <U>(values: List<U>): ObjectChain<Dictionary<U>>; (): ObjectChain<Dictionary<undefined>>;};
See Also
_.zipObject
interface CollectionChain
interface CollectionChain<T> {}
method zipObjectDeep
zipObjectDeep: (values?: List<any>) => ObjectChain<object>;
See Also
_.zipObjectDeep
interface CollectionChain
interface CollectionChain<T> {}
method zipWith
zipWith: { <T2, TResult>( arrays2: List<T2>, iteratee: (value1: T, value2: T2) => TResult ): CollectionChain<TResult>; <T2, T3, TResult>( arrays2: List<T2>, arrays3: List<T3>, iteratee: (value1: T, value2: T2, value3: T3) => TResult ): CollectionChain<TResult>; <TResult>( ...iteratee: (List<T> | ((...group: T[]) => TResult))[] ): CollectionChain<TResult>;};
See Also
_.zipWith
interface CollectionChain
interface CollectionChain<T> {}
method countBy
countBy: (iteratee?: ValueIteratee<T>) => ObjectChain<Dictionary<number>>;
See Also
_.countBy
interface CollectionChain
interface CollectionChain<T> {}
property each
each: CollectionChain<T>['forEach'];
See Also
_.each
interface CollectionChain
interface CollectionChain<T> {}
property eachRight
eachRight: CollectionChain<T>['forEachRight'];
See Also
_.eachRight
interface CollectionChain
interface CollectionChain<T> {}
method every
every: (predicate?: ListIterateeCustom<T, boolean>) => PrimitiveChain<boolean>;
See Also
_.every
interface CollectionChain
interface CollectionChain<T> {}
method filter
filter: { <S extends T>(predicate: ListIteratorTypeGuard<T, S>): CollectionChain<S>; (predicate?: ListIterateeCustom<T, boolean>): CollectionChain<T>;};
See Also
_.filter
interface CollectionChain
interface CollectionChain<T> {}
method find
find: { <S extends T>( predicate: ListIteratorTypeGuard<T, S>, fromIndex?: number ): ExpChain<S | undefined>; ( predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number ): ExpChain<T>;};
See Also
_.find
interface CollectionChain
interface CollectionChain<T> {}
method findLast
findLast: { <S extends T>( predicate: ListIteratorTypeGuard<T, S>, fromIndex?: number ): ExpChain<S | undefined>; ( predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number ): ExpChain<T>;};
See Also
_.findLast
interface CollectionChain
interface CollectionChain<T> {}
method flatMap
flatMap: { <TResult = any>( iteratee: ListIterator<T, Many<TResult>> | PropertyName ): CollectionChain<TResult>; (iteratee: object | [PropertyName, any]): CollectionChain<boolean>; (): T extends Many<infer U> ? CollectionChain<U> : CollectionChain<T>;};
See Also
_.flatMap
interface CollectionChain
interface CollectionChain<T> {}
method flatMapDeep
flatMapDeep: { <TResult = any>( iteratee: | ListIterator<T, ListOfRecursiveArraysOrValues<TResult> | TResult> | PropertyName ): CollectionChain<TResult>; (iteratee: object | [PropertyName, any]): CollectionChain<boolean>; (): CollectionChain<T>;};
See Also
_.flatMapDeep
interface CollectionChain
interface CollectionChain<T> {}
method flatMapDepth
flatMapDepth: { <TResult = any>( iteratee: | ListIterator<T, ListOfRecursiveArraysOrValues<TResult> | TResult> | PropertyName, depth?: number ): CollectionChain<TResult>; ( iteratee: object | [PropertyName, any], depth?: number ): CollectionChain<boolean>; (depth?: number): CollectionChain<T>;};
See Also
_.flatMapDepth
interface CollectionChain
interface CollectionChain<T> {}
method forEach
forEach: (iteratee?: ListIterator<T, any>) => CollectionChain<T>;
See Also
_.forEach
interface CollectionChain
interface CollectionChain<T> {}
method forEachRight
forEachRight: (iteratee?: ListIterator<T, any>) => CollectionChain<T>;
See Also
_.forEachRight
interface CollectionChain
interface CollectionChain<T> {}
method groupBy
groupBy: (iteratee?: ValueIteratee<T>) => ObjectChain<Dictionary<T[]>>;
See Also
_.groupBy
interface CollectionChain
interface CollectionChain<T> {}
method includes
includes: (target: T, fromIndex?: number) => PrimitiveChain<boolean>;
See Also
_.includes
interface CollectionChain
interface CollectionChain<T> {}
method keyBy
keyBy: ( iteratee?: ValueIterateeCustom<T, PropertyName>) => ObjectChain<Dictionary<T>>;
See Also
_.keyBy
interface CollectionChain
interface CollectionChain<T> {}
method map
map: { <K extends keyof T>(key: K): CollectionChain<T[K]>; <TResult>(iteratee: ListIterator<T, TResult>): CollectionChain<TResult>; (iteratee: PropertyName): CollectionChain<any>; (iteratee: object | [PropertyName, any]): CollectionChain<boolean>; (): CollectionChain<T>;};
See Also
_.map
interface CollectionChain
interface CollectionChain<T> {}
method orderBy
orderBy: ( iteratees?: Many< ListIterator<T, NotVoid> | PropertyName | PartialShallow<T> >, orders?: Many<boolean | 'asc' | 'desc'>) => CollectionChain<T>;
See Also
_.orderBy
interface CollectionChain
interface CollectionChain<T> {}
method partition
partition: { <U extends T>(callback: ValueIteratorTypeGuard<T, U>): LoDashExplicitWrapper< [U[], Array<Exclude<T, U>>] >; (callback: ValueIteratee<T>): LoDashExplicitWrapper<[T[], T[]]>;};
See Also
_.partition
interface CollectionChain
interface CollectionChain<T> {}
method reduce
reduce: { <TResult>( callback: MemoListIterator<T, TResult, List<T>>, accumulator: TResult ): ExpChain<TResult>; (callback: MemoListIterator<T, T, List<T>>): ExpChain<T>;};
See Also
_.reduce
interface CollectionChain
interface CollectionChain<T> {}
method reduceRight
reduceRight: { <TResult>( callback: MemoListIterator<T, TResult, List<T>>, accumulator: TResult ): ExpChain<TResult>; (callback: MemoListIterator<T, T, List<T>>): ExpChain<T>;};
See Also
_.reduceRight
interface CollectionChain
interface CollectionChain<T> {}
method reject
reject: (predicate?: ListIterateeCustom<T, boolean>) => CollectionChain<T>;
See Also
_.reject
interface CollectionChain
interface CollectionChain<T> {}
method sample
sample: () => ExpChain<T | undefined>;
See Also
_.sample
interface CollectionChain
interface CollectionChain<T> {}
method sampleSize
sampleSize: (n?: number) => CollectionChain<T>;
See Also
_.sampleSize
interface CollectionChain
interface CollectionChain<T> {}
method shuffle
shuffle: () => CollectionChain<T>;
See Also
_.shuffle
interface CollectionChain
interface CollectionChain<T> {}
method some
some: (predicate?: ListIterateeCustom<T, boolean>) => PrimitiveChain<boolean>;
See Also
_.some
interface CollectionChain
interface CollectionChain<T> {}
method sortBy
sortBy: (...iteratees: Array<Many<ListIteratee<T>>>) => CollectionChain<T>;
See Also
_.sortBy
interface CollectionChain
interface CollectionChain<T> {}
method castArray
castArray: () => CollectionChain<T>;
See Also
_.castArray
interface CollectionChain
interface CollectionChain<T> {}
method toArray
toArray: () => CollectionChain<T>;
See Also
_.toArray
interface CollectionChain
interface CollectionChain<T> {}
method max
max: () => ExpChain<T | undefined>;
See Also
_.max
interface CollectionChain
interface CollectionChain<T> {}
method maxBy
maxBy: (iteratee?: ValueIteratee<T>) => ExpChain<T | undefined>;
See Also
_.maxBy
interface CollectionChain
interface CollectionChain<T> {}
method meanBy
meanBy: (iteratee?: ValueIteratee<T>) => PrimitiveChain<number>;
See Also
_.meanBy
interface CollectionChain
interface CollectionChain<T> {}
method min
min: () => ExpChain<T | undefined>;
See Also
_.min
interface CollectionChain
interface CollectionChain<T> {}
method minBy
minBy: (iteratee?: ValueIteratee<T>) => ExpChain<T | undefined>;
See Also
_.minBy
interface CollectionChain
interface CollectionChain<T> {}
method sumBy
sumBy: (iteratee?: string | ((value: T) => number)) => PrimitiveChain<number>;
See Also
_.sumBy
interface CollectionChain
interface CollectionChain<T> {}
method at
at: (...props: PropertyPath[]) => CollectionChain<T>;
See Also
_.at
interface CollectionChain
interface CollectionChain<T> {}
method get
get: { (path: number): ExpChain<T>; <TDefault>(path: number, defaultValue: TDefault): | ExpChain<T> | ExpChain<TDefault>;};
See Also
_.get
interface CollectionChain
interface CollectionChain<T> {}
method invertBy
invertBy: (iteratee?: ValueIteratee<T>) => ObjectChain<Dictionary<string[]>>;
See Also
_.invertBy
interface CollectionChain
interface CollectionChain<T> {}
method mapKeys
mapKeys: (iteratee?: ListIteratee<T>) => ObjectChain<Dictionary<T>>;
See Also
_.mapKeys
interface CollectionChain
interface CollectionChain<T> {}
method mapValues
mapValues: { <TResult>(callback: ArrayIterator<T, TResult>): ObjectChain< NumericDictionary<TResult> >; <TKey extends keyof T>(iteratee: TKey): ObjectChain<Dictionary<T[TKey]>>; (iteratee: object): ObjectChain<Dictionary<boolean>>; (iteratee: string): ObjectChain<Dictionary<any>>; (): ObjectChain<Dictionary<T>>;};
See Also
_.mapValues
interface CollectionChain
interface CollectionChain<T> {}
method omit
omit: (...paths: Array<Many<PropertyName>>) => CollectionChain<T>;
See Also
_.omit
interface CollectionChain
interface CollectionChain<T> {}
method omitBy
omitBy: (predicate?: ValueKeyIteratee<T>) => ObjectChain<Dictionary<T>>;
See Also
_.omitBy
interface CollectionChain
interface CollectionChain<T> {}
method pickBy
pickBy: { <S extends T>(predicate: ValueKeyIterateeTypeGuard<T, S>): ObjectChain< Dictionary<S> >; (predicate?: ValueKeyIteratee<T>): ObjectChain<Dictionary<T>>;};
See Also
_.pickBy
interface CollectionChain
interface CollectionChain<T> {}
method transform
transform: { <TResult>( iteratee: MemoVoidArrayIterator<T, TResult>, accumulator?: TResult ): ExpChain<TResult>; (): CollectionChain<any>;};
See Also
_.transform
interface CollectionChain
interface CollectionChain<T> {}
method iteratee
iteratee: () => FunctionChain<(o: object) => boolean>;
See Also
_.iteratee
interface CollectionChain
interface CollectionChain<T> {}
method over
over: <TResult>( ...iteratees: Many<(...args: any[]) => TResult>[]) => FunctionChain<(...args: any[]) => TResult[]>;
See Also
_.over
interface CollectionChain
interface CollectionChain<T> {}
method overEvery
overEvery: <TArgs>( ...iteratees: Many<(...args: TArgs[]) => boolean>[]) => FunctionChain<(...args: TArgs[]) => boolean>;
See Also
_.overEvery
interface CollectionChain
interface CollectionChain<T> {}
method overSome
overSome: <TArgs>( ...iteratees: Many<(...args: TArgs[]) => boolean>[]) => FunctionChain<(...args: TArgs[]) => boolean>;
See Also
_.overSome
interface CurriedFunction1
interface CurriedFunction1<T1, R> {}
call signature
(): CurriedFunction1<T1, R>;
call signature
(t1: T1): R;
interface CurriedFunction2
interface CurriedFunction2<T1, T2, R> {}
call signature
(): CurriedFunction2<T1, T2, R>;
call signature
(t1: T1): CurriedFunction1<T2, R>;
call signature
(t1: __, t2: T2): CurriedFunction1<T1, R>;
call signature
(t1: T1, t2: T2): R;
interface CurriedFunction3
interface CurriedFunction3<T1, T2, T3, R> {}
call signature
(): CurriedFunction3<T1, T2, T3, R>;
call signature
(t1: T1): CurriedFunction2<T2, T3, R>;
call signature
(t1: __, t2: T2): CurriedFunction2<T1, T3, R>;
call signature
(t1: T1, t2: T2): CurriedFunction1<T3, R>;
call signature
(t1: __, t2: __, t3: T3): CurriedFunction2<T1, T2, R>;
call signature
(t1: T1, t2: __, t3: T3): CurriedFunction1<T2, R>;
call signature
(t1: __, t2: T2, t3: T3): CurriedFunction1<T1, R>;
call signature
(t1: T1, t2: T2, t3: T3): R;
interface CurriedFunction4
interface CurriedFunction4<T1, T2, T3, T4, R> {}
call signature
(): CurriedFunction4<T1, T2, T3, T4, R>;
call signature
(t1: T1): CurriedFunction3<T2, T3, T4, R>;
call signature
(t1: __, t2: T2, t3: __, t4: T4): CurriedFunction2<T1, T3, R>;
call signature
(t1: __, t2: __, t3: T3, t4: T4): CurriedFunction2<T1, T2, R>;
call signature
(t1: T1, t2: T2, t3: __, t4: T4): CurriedFunction1<T3, R>;
call signature
(t1: T1, t2: __, t3: T3, t4: T4): CurriedFunction1<T2, R>;
call signature
(t1: __, t2: T2, t3: T3, t4: T4): CurriedFunction1<T1, R>;
call signature
(t1: T1, t2: T2, t3: T3, t4: T4): R;
call signature
(t1: __, t2: T2): CurriedFunction3<T1, T3, T4, R>;
call signature
(t1: T1, t2: T2): CurriedFunction2<T3, T4, R>;
call signature
(t1: __, t2: __, t3: T3): CurriedFunction3<T1, T2, T4, R>;
call signature
(t1: __, t2: __, t3: T3): CurriedFunction2<T2, T4, R>;
call signature
(t1: __, t2: T2, t3: T3): CurriedFunction2<T1, T4, R>;
call signature
(t1: T1, t2: T2, t3: T3): CurriedFunction1<T4, R>;
call signature
(t1: __, t2: __, t3: __, t4: T4): CurriedFunction3<T1, T2, T3, R>;
call signature
(t1: T1, t2: __, t3: __, t4: T4): CurriedFunction2<T2, T3, R>;
interface CurriedFunction5
interface CurriedFunction5<T1, T2, T3, T4, T5, R> {}
call signature
(): CurriedFunction5<T1, T2, T3, T4, T5, R>;
call signature
(t1: T1): CurriedFunction4<T2, T3, T4, T5, R>;
call signature
(t1: __, t2: T2, t3: __, t4: T4): CurriedFunction3<T1, T3, T5, R>;
call signature
(t1: __, t2: __, t3: T3, t4: T4): CurriedFunction3<T1, T2, T5, R>;
call signature
(t1: T1, t2: T2, t3: __, t4: T4): CurriedFunction2<T3, T5, R>;
call signature
(t1: T1, t2: __, t3: T3, t4: T4): CurriedFunction2<T2, T5, R>;
call signature
(t1: __, t2: T2, t3: T3, t4: T4): CurriedFunction2<T1, T5, R>;
call signature
(t1: T1, t2: T2, t3: T3, t4: T4): CurriedFunction1<T5, R>;
call signature
(t1: __, t2: __, t3: __, t4: __, t5: T5): CurriedFunction4<T1, T2, T3, T4, R>;
call signature
(t1: T1, t2: __, t3: __, t4: __, t5: T5): CurriedFunction3<T2, T3, T4, R>;
call signature
(t1: __, t2: T2, t3: __, t4: __, t5: T5): CurriedFunction3<T1, T3, T4, R>;
call signature
(t1: __, t2: __, t3: T3, t4: __, t5: T5): CurriedFunction3<T1, T2, T4, R>;
call signature
(t1: __, t2: T2): CurriedFunction4<T1, T3, T4, T5, R>;
call signature
(t1: __, t2: __, t3: __, t4: T4, t5: T5): CurriedFunction3<T1, T2, T3, R>;
call signature
(t1: T1, t2: T2, t3: __, t4: __, t5: T5): CurriedFunction2<T3, T4, R>;
call signature
(t1: T1, t2: __, t3: T3, t4: __, t5: T5): CurriedFunction2<T2, T4, R>;
call signature
(t1: T1, t2: __, t3: __, t4: T4, t5: T5): CurriedFunction2<T2, T3, R>;
call signature
(t1: __, t2: T2, t3: T3, t4: __, t5: T5): CurriedFunction2<T1, T4, R>;
call signature
(t1: __, t2: T2, t3: __, t4: T4, t5: T5): CurriedFunction2<T1, T3, R>;
call signature
(t1: __, t2: __, t3: T3, t4: T4, t5: T5): CurriedFunction2<T1, T2, R>;
call signature
(t1: T1, t2: T2, t3: T3, t4: __, t5: T5): CurriedFunction1<T4, R>;
call signature
(t1: T1, t2: T2, t3: __, t4: T4, t5: T5): CurriedFunction1<T3, R>;
call signature
(t1: T1, t2: __, t3: T3, t4: T4, t5: T5): CurriedFunction1<T2, R>;
call signature
(t1: T1, t2: T2): CurriedFunction3<T3, T4, T5, R>;
call signature
(t1: __, t2: T2, t3: T3, t4: T4, t5: T5): CurriedFunction1<T1, R>;
call signature
(t1: T1, t2: T2, t3: T3, t4: T4, t5: T5): R;
call signature
(t1: __, t2: __, t3: T3): CurriedFunction4<T1, T2, T4, T5, R>;
call signature
(t1: T1, t2: __, t3: T3): CurriedFunction3<T2, T4, T5, R>;
call signature
(t1: __, t2: T2, t3: T3): CurriedFunction3<T1, T4, T5, R>;
call signature
(t1: T1, t2: T2, t3: T3): CurriedFunction2<T4, T5, R>;
call signature
(t1: __, t2: __, t3: __, t4: T4): CurriedFunction4<T1, T2, T3, T5, R>;
call signature
(t1: T1, t2: __, t3: __, t4: T4): CurriedFunction3<T2, T3, T5, R>;
interface Curry
interface Curry {}
property placeholder
placeholder: __;
call signature
<T1, R>(func: (t1: T1) => R, arity?: number): CurriedFunction1<T1, R>;
call signature
<T1, T2, R>(func: (t1: T1, t2: T2) => R, arity?: number): CurriedFunction2< T1, T2, R>;
call signature
<T1, T2, T3, R>( func: (t1: T1, t2: T2, t3: T3) => R, arity?: number): CurriedFunction3<T1, T2, T3, R>;
call signature
<T1, T2, T3, T4, R>( func: (t1: T1, t2: T2, t3: T3, t4: T4) => R, arity?: number): CurriedFunction4<T1, T2, T3, T4, R>;
call signature
<T1, T2, T3, T4, T5, R>( func: (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5) => R, arity?: number): CurriedFunction5<T1, T2, T3, T4, T5, R>;
call signature
(func: (...args: any[]) => any, arity?: number): (...args: any[]) => any;
interface CurryRight
interface CurryRight {}
property placeholder
placeholder: __;
call signature
<T1, R>(func: (t1: T1) => R, arity?: number): RightCurriedFunction1<T1, R>;
call signature
<T1, T2, R>(func: (t1: T1, t2: T2) => R, arity?: number): RightCurriedFunction2< T1, T2, R>;
call signature
<T1, T2, T3, R>( func: (t1: T1, t2: T2, t3: T3) => R, arity?: number): RightCurriedFunction3<T1, T2, T3, R>;
call signature
<T1, T2, T3, T4, R>( func: (t1: T1, t2: T2, t3: T3, t4: T4) => R, arity?: number): RightCurriedFunction4<T1, T2, T3, T4, R>;
call signature
<T1, T2, T3, T4, T5, R>( func: (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5) => R, arity?: number): RightCurriedFunction5<T1, T2, T3, T4, T5, R>;
call signature
(func: (...args: any[]) => any, arity?: number): (...args: any[]) => any;
interface DebouncedFunc
interface DebouncedFunc<T extends (...args: any[]) => any> {}
method cancel
cancel: () => void;
Throw away any pending invocation of the debounced function.
method flush
flush: () => ReturnType<T> | undefined;
If there is a pending invocation of the debounced function, invoke it immediately and return its return value.
Otherwise, return the value from the last invocation, or undefined if the debounced function was never invoked.
call signature
(...args: Parameters<T>): ReturnType<T> | undefined;
Call the original function, but applying the debounce rules.
If the debounced function can be run immediately, this calls it and returns its return value.
Otherwise, it returns the return value of the last invocation, or undefined if the debounced function was not invoked yet.
interface DebouncedFuncLeading
interface DebouncedFuncLeading<T extends (...args: any[]) => any> extends DebouncedFunc<T> {}
method flush
flush: () => ReturnType<T>;
call signature
(...args: Parameters<T>): ReturnType<T>;
interface DebounceSettings
interface DebounceSettings {}
interface DebounceSettingsLeading
interface DebounceSettingsLeading extends DebounceSettings {}
property leading
leading: true;
interface Dictionary
interface Dictionary<T> {}
index signature
[index: string]: T;
interface Function
interface Function<T extends (...args: any) => any> extends LoDashImplicitWrapper<T> {}
interface Function
interface Function<T extends (...args: any) => any> {}
method ary
ary: (n?: number) => Function<(...args: any[]) => any>;
See Also
_.ary
interface Function
interface Function<T extends (...args: any) => any> {}
method curry
curry: ( arity?: number) => T extends (arg1: infer T1) => infer R ? Function<CurriedFunction1<T1, R>> : T extends (arg1: infer T1, arg2: infer T2) => infer R ? Function<CurriedFunction2<T1, T2, R>> : T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3) => infer R ? Function<CurriedFunction3<T1, T2, T3, R>> : T extends ( arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4 ) => infer R ? Function<CurriedFunction4<T1, T2, T3, T4, R>> : T extends ( arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4, arg5: infer T5 ) => infer R ? Function<CurriedFunction5<T1, T2, T3, T4, T5, R>> : Function<(...args: any[]) => any>;
See Also
_.curry
interface Function
interface Function<T extends (...args: any) => any> {}
method curryRight
curryRight: ( arity?: number) => T extends (arg1: infer T1) => infer R ? Function<RightCurriedFunction1<T1, R>> : T extends (arg1: infer T1, arg2: infer T2) => infer R ? Function<RightCurriedFunction2<T1, T2, R>> : T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3) => infer R ? Function<RightCurriedFunction3<T1, T2, T3, R>> : T extends ( arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4 ) => infer R ? Function<RightCurriedFunction4<T1, T2, T3, T4, R>> : T extends ( arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4, arg5: infer T5 ) => infer R ? Function<RightCurriedFunction5<T1, T2, T3, T4, T5, R>> : Function<(...args: any[]) => any>;
See Also
_.curryRight
interface Function
interface Function<T extends (...args: any) => any> {}
method debounce
debounce: { (wait: number | undefined, options: DebounceSettingsLeading): T extends ( ...args: any[] ) => any ? Function<DebouncedFuncLeading<T>> : never; (wait?: number, options?: DebounceSettings): T extends ( ...args: any[] ) => any ? Function<DebouncedFunc<T>> : never;};
See Also
_.debounce
interface Function
interface Function<T extends (...args: any) => any> {}
method flip
flip: () => this;
See Also
_.flip
interface Function
interface Function<T extends (...args: any) => any> {}
method memoize
memoize: (resolver?: (...args: any[]) => any) => Function<T & MemoizedFunction>;
See Also
_.memoize
interface Function
interface Function<T extends (...args: any) => any> {}
method negate
negate: () => Function<(...args: Parameters<T>) => boolean>;
See Also
_.negate
interface Function
interface Function<T extends (...args: any) => any> {}
method once
once: () => Function<T>;
See Also
_.once
interface Function
interface Function<T extends (...args: any) => any> {}
method overArgs
overArgs: ( ...transforms: Many<(...args: any[]) => any>[]) => Function<(...args: any[]) => any>;
See Also
_.overArgs
interface Function
interface Function<T extends (...args: any) => any> {}
method partial
partial: { <T2>(plc1: __, arg2: T2): Function< T extends Function2<infer T1, T2, infer R> ? Function1<T1, R> : T extends Function3<infer T1, T2, infer T3, infer R> ? Function2<T1, T3, R> : T extends Function4<infer T1, T2, infer T3, infer T4, infer R> ? Function3<T1, T3, T4, R> : any >; <T3>(plc1: LoDashStatic, plc2: LoDashStatic, arg3: T3): Function< T extends Function3<infer T1, infer T2, T3, infer R> ? Function2<T1, T2, R> : T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> : any >; <T1, T3>(arg1: T1, plc2: LoDashStatic, arg3: T3): Function< T extends Function3<T1, infer T2, T3, infer R> ? Function1<T2, R> : T extends Function4<T1, infer T2, T3, infer T4, infer R> ? Function2<T2, T4, R> : any >; <T2, T3>(plc1: LoDashStatic, arg2: T2, arg3: T3): Function< T extends Function3<infer T1, T2, T3, infer R> ? Function1<T1, R> : T extends Function4<infer T1, T2, T3, infer T4, infer R> ? Function2<T1, T4, R> : any >; <T3>(plc1: LoDashStatic, plc2: LoDashStatic, arg3: T3): Function< T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> : any >; <T1, T4>( arg1: T1, plc2: LoDashStatic, plc3: LoDashStatic, arg4: T4 ): Function< T extends Function4<T1, infer T2, infer T3, T4, infer R> ? Function2<T2, T3, R> : any >; <T2, T4>( plc1: LoDashStatic, arg2: T2, plc3: LoDashStatic, arg4: T4 ): Function< T extends Function4<infer T1, T2, infer T3, T4, infer R> ? Function2<T1, T3, R> : any >; <T1, T2, T4>(arg1: T1, arg2: T2, plc3: LoDashStatic, arg4: T4): Function< T extends Function4<T1, T2, infer T3, T4, infer R> ? Function1<T3, R> : any >; <T3, T4>( plc1: LoDashStatic, plc2: LoDashStatic, arg3: T3, arg4: T4 ): Function< T extends Function4<infer T1, infer T2, T3, T4, infer R> ? Function2<T1, T2, R> : any >; <T1, T3, T4>(arg1: T1, plc2: LoDashStatic, arg3: T3, arg4: T4): Function< T extends Function4<T1, infer T2, T3, T4, infer R> ? Function1<T2, R> : any >; <T2, T3, T4>(plc1: LoDashStatic, arg2: T2, arg3: T3, arg4: T4): Function< T extends Function4<infer T1, T2, T3, T4, infer R> ? Function1<T1, R> : any >; <T1, T2, T3, T4>(arg1: T1, arg2: T2, arg3: T3, arg4: T4): Function< T extends (t1: T1, t2: T2, t3: T3, t4: T4, ...ts: infer TS) => infer R ? (...ts: TS) => R : any >; <T1, T2, T3>(arg1: T1, arg2: T2, arg3: T3): Function< T extends (t1: T1, t2: T2, t3: T3, ...ts: infer TS) => infer R ? (...ts: TS) => R : any >; <T1, T2>(arg1: T1, arg2: T2): Function< T extends (t1: T1, t2: T2, ...ts: infer TS) => infer R ? (...ts: TS) => R : any >; <T1>(arg1: T1): Function< T extends (t1: T1, ...ts: infer TS) => infer R ? (...ts: TS) => R : any >; (): Function<T extends (...ts: any[]) => any ? T : any>;};
See Also
_.partial
interface Function
interface Function<T extends (...args: any) => any> {}
method partialRight
partialRight: { <T1>(arg1: T1, plc2: __): Function< T extends Function2<T1, infer T2, infer R> ? Function1<T2, R> : any >; <T2>(arg2: T2): Function< T extends Function2<infer T1, T2, infer R> ? Function1<T1, R> : any >; <T1>(arg1: T1, plc2: LoDashStatic, plc3: LoDashStatic): Function< T extends Function3<T1, infer T2, infer T3, infer R> ? Function2<T2, T3, R> : any >; <T2>(arg2: T2, plc3: LoDashStatic): Function< T extends Function3<infer T1, T2, infer T3, infer R> ? Function2<T1, T3, R> : any >; <T1, T2>(arg1: T1, arg2: T2, plc3: LoDashStatic): Function< T extends Function3<T1, T2, infer T3, infer R> ? Function1<T3, R> : any >; <T3>(arg3: T3): Function< T extends Function3<infer T1, infer T2, T3, infer R> ? Function2<T1, T2, R> : any >; <T1, T3>(arg1: T1, plc2: LoDashStatic, arg3: T3): Function< T extends Function3<T1, infer T2, T3, infer R> ? Function1<T2, R> : any >; <T2, T3>(arg2: T2, arg3: T3): Function< T extends Function3<infer T1, T2, T3, infer R> ? Function1<T1, R> : any >; <T1>( arg1: T1, plc2: LoDashStatic, plc3: LoDashStatic, plc4: LoDashStatic ): Function< T extends Function4<T1, infer T2, infer T3, infer T4, infer R> ? Function3<T2, T3, T4, R> : any >; <T2>(arg2: T2, plc3: LoDashStatic, plc4: LoDashStatic): Function< T extends Function4<infer T1, T2, infer T3, infer T4, infer R> ? Function3<T1, T3, T4, R> : any >; <T1, T2>( arg1: T1, arg2: T2, plc3: LoDashStatic, plc4: LoDashStatic ): Function< T extends Function4<T1, T2, infer T3, infer T4, infer R> ? Function2<T3, T4, R> : any >; <T3>(arg3: T3, plc4: LoDashStatic): Function< T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> : any >; <T1, T3>( arg1: T1, plc2: LoDashStatic, arg3: T3, plc4: LoDashStatic ): Function< T extends Function4<T1, infer T2, infer T3, infer T4, infer R> ? Function2<T2, T4, R> : any >; <T2, T3>(arg2: T2, arg3: T3, plc4: LoDashStatic): Function< T extends Function4<infer T1, T2, T3, infer T4, infer R> ? Function2<T1, T4, R> : any >; <T1, T2, T3>(arg1: T1, arg2: T2, arg3: T3, plc4: LoDashStatic): Function< T extends Function4<T1, T2, T3, infer T4, infer R> ? Function1<T4, R> : any >; <T4>(arg4: T4): Function< T extends Function4<infer T1, infer T2, infer T3, T4, infer R> ? Function3<T1, T2, T3, R> : any >; <T1, T4>( arg1: T1, plc2: LoDashStatic, plc3: LoDashStatic, arg4: T4 ): Function< T extends Function4<T1, infer T2, infer T3, T4, infer R> ? Function2<T2, T3, R> : any >; <T2, T4>(arg2: T2, plc3: LoDashStatic, arg4: T4): Function< T extends Function4<infer T1, T2, infer T3, T4, infer R> ? Function2<T1, T3, R> : any >; <T1, T2, T4>(arg1: T1, arg2: T2, plc3: LoDashStatic, arg4: T4): Function< T extends Function4<T1, T2, infer T3, T4, infer R> ? Function1<T3, R> : any >; <T3, T4>(arg3: T3, arg4: T4): Function< T extends Function4<infer T1, infer T2, T3, T4, infer R> ? Function2<T1, T2, R> : any >; <T1, T3, T4>(arg1: T1, plc2: LoDashStatic, arg3: T3, arg4: T4): Function< T extends Function4<T1, infer T2, T3, T4, infer R> ? Function1<T2, R> : any >; <T2, T3, T4>(arg2: T2, arg3: T3, arg4: T4): Function< T extends Function4<infer T1, T2, T3, T4, infer R> ? Function1<T1, R> : any >; <TS extends any[]>(...ts: TS): Function< T extends (...args: TS) => infer R ? () => R : any >; (): Function<T extends (...ts: any[]) => any ? T : any>;};
See Also
_.partialRight
interface Function
interface Function<T extends (...args: any) => any> {}
method rearg
rearg: (...indexes: Array<Many<number>>) => Function<(...args: any[]) => any>;
See Also
_.rearg
interface Function
interface Function<T extends (...args: any) => any> {}
method rest
rest: (start?: number) => Function<(...args: any[]) => any>;
See Also
_.rest
interface Function
interface Function<T extends (...args: any) => any> {}
method spread
spread: (start?: number) => Function<(...args: any[]) => ReturnType<T>>;
See Also
_.spread
interface Function
interface Function<T extends (...args: any) => any> {}
method throttle
throttle: { (wait?: number, options?: ThrottleSettingsLeading): T extends ( ...args: any[] ) => any ? Function<DebouncedFuncLeading<T>> : never; (wait?: number, options?: ThrottleSettings): T extends ( ...args: any[] ) => any ? Function<DebouncedFunc<T>> : never;};
See Also
_.throttle
interface Function
interface Function<T extends (...args: any) => any> {}
method unary
unary: () => Function<(arg1: Parameters<T>['0']) => ReturnType<T>>;
See Also
_.unary
interface Function
interface Function<T extends (...args: any) => any> {}
method castArray
castArray: () => Collection<T>;
See Also
_.castArray
interface Function
interface Function<T extends (...args: any) => any> {}
method chain
chain: () => FunctionChain<T>;
See Also
_.chain
interface Function
interface Function<T extends (...arg: any) => any> {}
method flow
flow: { <R2, R3, R4, R5, R6, R7>( f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5, f6: (a: R5) => R6, f7: (a: R6) => R7 ): Function<(...args: Parameters<T>) => R7>; <R2, R3, R4, R5, R6, R7>( f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5, f6: (a: R5) => R6, f7: (a: R6) => R7, ...func: Many<(a: any) => any>[] ): Function<(...args: Parameters<T>) => any>; <R2, R3, R4, R5, R6>( f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5, f6: (a: R5) => R6 ): Function<(...args: Parameters<T>) => R6>; <R2, R3, R4, R5>( f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5 ): Function<(...args: Parameters<T>) => R5>; <R2, R3, R4>( f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4 ): Function<(...args: Parameters<T>) => R4>; <R2, R3>(f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3): Function< (...args: Parameters<T>) => R3 >; <R2>(f2: (a: ReturnType<T>) => R2): Function<(...args: Parameters<T>) => R2>; (...func: Many<(...args: any[]) => any>[]): Function< (...args: any[]) => any >;};
See Also
_.flow
interface Function
interface Function<T> {}
method flowRight
flowRight: { <A extends any[], R1, R2, R3, R4, R5>( f6: (a: R5) => Parameters<T>['0'], f5: (a: R4) => R5, f4: (a: R3) => R4, f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): Function<(...args: A) => ReturnType<T>>; <A extends any[], R1, R2, R3, R4>( f5: (a: R4) => Parameters<T>['0'], f4: (a: R3) => R4, f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): Function<(...args: A) => ReturnType<T>>; <A extends any[], R1, R2, R3>( f4: (a: R3) => Parameters<T>['0'], f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): Function<(...args: A) => ReturnType<T>>; <A extends any[], R1, R2>( f3: (a: R2) => Parameters<T>['0'], f2: (a: R1) => R2, f1: (...args: A) => R1 ): Function<(...args: A) => ReturnType<T>>; <A extends any[], R1>( f2: (a: R1) => Parameters<T>['0'], f1: (...args: A) => R1 ): Function<(...args: A) => ReturnType<T>>; <A extends any[]>(f1: (...args: A) => Parameters<T>['0']): Function< (...args: A) => ReturnType<T> >; (...func: Many<(...args: any[]) => any>[]): Function< (...args: any[]) => any >;};
See Also
_.flowRight
interface Function
interface Function<T extends (...args: any) => any> {}
method iteratee
iteratee: () => Function<T>;
See Also
_.iteratee
interface Function
interface Function<T> {}
method over
over: <TResult>( ...iteratees: Many<(...args: any[]) => TResult>[]) => Function<(...args: any[]) => Array<ReturnType<T> | TResult>>;
See Also
_.over
interface Function
interface Function<T> {}
method overEvery
overEvery: <TArgs>( ...iteratees: Many<(...args: TArgs[]) => boolean>[]) => Function<(...args: Parameters<T> | TArgs[]) => boolean>;
See Also
_.overEvery
interface Function
interface Function<T> {}
method overSome
overSome: <TArgs>( ...iteratees: Many<(...args: TArgs[]) => boolean>[]) => Function<(...args: Parameters<T> | TArgs[]) => boolean>;
See Also
_.overSome
interface FunctionBind
interface FunctionBind {}
property placeholder
placeholder: __;
See Also
_.placeholder
call signature
(func: (...args: any[]) => any, thisArg: any, ...partials: any[]): ( ...args: any[]) => any;
interface FunctionBindKey
interface FunctionBindKey {}
property placeholder
placeholder: __;
call signature
(object: object, key: string, ...partials: any[]): (...args: any[]) => any;
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> extends LoDashExplicitWrapper<T> {}
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method ary
ary: (n?: number) => FunctionChain<(...args: any[]) => any>;
See Also
_.ary
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method curry
curry: ( arity?: number) => T extends (arg1: infer T1) => infer R ? FunctionChain<CurriedFunction1<T1, R>> : T extends (arg1: infer T1, arg2: infer T2) => infer R ? FunctionChain<CurriedFunction2<T1, T2, R>> : T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3) => infer R ? FunctionChain<CurriedFunction3<T1, T2, T3, R>> : T extends ( arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4 ) => infer R ? FunctionChain<CurriedFunction4<T1, T2, T3, T4, R>> : T extends ( arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4, arg5: infer T5 ) => infer R ? FunctionChain<CurriedFunction5<T1, T2, T3, T4, T5, R>> : FunctionChain<(...args: any[]) => any>;
See Also
_.curry
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method curryRight
curryRight: ( arity?: number) => T extends (arg1: infer T1) => infer R ? FunctionChain<RightCurriedFunction1<T1, R>> : T extends (arg1: infer T1, arg2: infer T2) => infer R ? FunctionChain<RightCurriedFunction2<T1, T2, R>> : T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3) => infer R ? FunctionChain<RightCurriedFunction3<T1, T2, T3, R>> : T extends ( arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4 ) => infer R ? FunctionChain<RightCurriedFunction4<T1, T2, T3, T4, R>> : T extends ( arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4, arg5: infer T5 ) => infer R ? FunctionChain<RightCurriedFunction5<T1, T2, T3, T4, T5, R>> : FunctionChain<(...args: any[]) => any>;
See Also
_.curryRight
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method debounce
debounce: { (wait: number | undefined, options: DebounceSettingsLeading): T extends ( ...args: any[] ) => any ? FunctionChain<DebouncedFuncLeading<T>> : never; (wait?: number, options?: DebounceSettings): T extends ( ...args: any[] ) => any ? FunctionChain<DebouncedFunc<T>> : never;};
See Also
_.debounce
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method flip
flip: () => this;
See Also
_.flip
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method memoize
memoize: ( resolver?: (...args: any[]) => any) => FunctionChain<T & MemoizedFunction>;
See Also
_.memoize
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method negate
negate: () => FunctionChain<(...args: Parameters<T>) => boolean>;
See Also
_.negate
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method once
once: () => FunctionChain<T>;
See Also
_.once
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method overArgs
overArgs: ( ...transforms: Many<(...args: any[]) => any>[]) => FunctionChain<(...args: any[]) => any>;
See Also
_.overArgs
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method partial
partial: { <T2>(plc1: __, arg2: T2): FunctionChain< T extends Function2<infer T1, T2, infer R> ? Function1<T1, R> : T extends Function3<infer T1, T2, infer T3, infer R> ? Function2<T1, T3, R> : T extends Function4<infer T1, T2, infer T3, infer T4, infer R> ? Function3<T1, T3, T4, R> : any >; <T3>(plc1: LoDashStatic, plc2: LoDashStatic, arg3: T3): FunctionChain< T extends Function3<infer T1, infer T2, T3, infer R> ? Function2<T1, T2, R> : T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> : any >; <T1, T3>(arg1: T1, plc2: LoDashStatic, arg3: T3): FunctionChain< T extends Function3<T1, infer T2, T3, infer R> ? Function1<T2, R> : T extends Function4<T1, infer T2, T3, infer T4, infer R> ? Function2<T2, T4, R> : any >; <T2, T3>(plc1: LoDashStatic, arg2: T2, arg3: T3): FunctionChain< T extends Function3<infer T1, T2, T3, infer R> ? Function1<T1, R> : T extends Function4<infer T1, T2, T3, infer T4, infer R> ? Function2<T1, T4, R> : any >; <T3>(plc1: LoDashStatic, plc2: LoDashStatic, arg3: T3): FunctionChain< T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> : any >; <T1, T4>( arg1: T1, plc2: LoDashStatic, plc3: LoDashStatic, arg4: T4 ): FunctionChain< T extends Function4<T1, infer T2, infer T3, T4, infer R> ? Function2<T2, T3, R> : any >; <T2, T4>( plc1: LoDashStatic, arg2: T2, plc3: LoDashStatic, arg4: T4 ): FunctionChain< T extends Function4<infer T1, T2, infer T3, T4, infer R> ? Function2<T1, T3, R> : any >; <T1, T2, T4>( arg1: T1, arg2: T2, plc3: LoDashStatic, arg4: T4 ): FunctionChain< T extends Function4<T1, T2, infer T3, T4, infer R> ? Function1<T3, R> : any >; <T3, T4>( plc1: LoDashStatic, plc2: LoDashStatic, arg3: T3, arg4: T4 ): FunctionChain< T extends Function4<infer T1, infer T2, T3, T4, infer R> ? Function2<T1, T2, R> : any >; <T1, T3, T4>( arg1: T1, plc2: LoDashStatic, arg3: T3, arg4: T4 ): FunctionChain< T extends Function4<T1, infer T2, T3, T4, infer R> ? Function1<T2, R> : any >; <T2, T3, T4>( plc1: LoDashStatic, arg2: T2, arg3: T3, arg4: T4 ): FunctionChain< T extends Function4<infer T1, T2, T3, T4, infer R> ? Function1<T1, R> : any >; <T1, T2, T3, T4>(arg1: T1, arg2: T2, arg3: T3, arg4: T4): FunctionChain< T extends (t1: T1, t2: T2, t3: T3, t4: T4, ...ts: infer TS) => infer R ? (...ts: TS) => R : any >; <T1, T2, T3>(arg1: T1, arg2: T2, arg3: T3): FunctionChain< T extends (t1: T1, t2: T2, t3: T3, ...ts: infer TS) => infer R ? (...ts: TS) => R : any >; <T1, T2>(arg1: T1, arg2: T2): FunctionChain< T extends (t1: T1, t2: T2, ...ts: infer TS) => infer R ? (...ts: TS) => R : any >; <T1>(arg1: T1): FunctionChain< T extends (t1: T1, ...ts: infer TS) => infer R ? (...ts: TS) => R : any >; (): FunctionChain<T extends (...ts: any[]) => any ? T : any>;};
See Also
_.partial
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method partialRight
partialRight: { <T1>(arg1: T1, plc2: __): FunctionChain< T extends Function2<T1, infer T2, infer R> ? Function1<T2, R> : any >; <T2>(arg2: T2): FunctionChain< T extends Function2<infer T1, T2, infer R> ? Function1<T1, R> : any >; <T1>(arg1: T1, plc2: LoDashStatic, plc3: LoDashStatic): FunctionChain< T extends Function3<T1, infer T2, infer T3, infer R> ? Function2<T2, T3, R> : any >; <T2>(arg2: T2, plc3: LoDashStatic): FunctionChain< T extends Function3<infer T1, T2, infer T3, infer R> ? Function2<T1, T3, R> : any >; <T1, T2>(arg1: T1, arg2: T2, plc3: LoDashStatic): FunctionChain< T extends Function3<T1, T2, infer T3, infer R> ? Function1<T3, R> : any >; <T3>(arg3: T3): FunctionChain< T extends Function3<infer T1, infer T2, T3, infer R> ? Function2<T1, T2, R> : any >; <T1, T3>(arg1: T1, plc2: LoDashStatic, arg3: T3): FunctionChain< T extends Function3<T1, infer T2, T3, infer R> ? Function1<T2, R> : any >; <T2, T3>(arg2: T2, arg3: T3): FunctionChain< T extends Function3<infer T1, T2, T3, infer R> ? Function1<T1, R> : any >; <T1>( arg1: T1, plc2: LoDashStatic, plc3: LoDashStatic, plc4: LoDashStatic ): FunctionChain< T extends Function4<T1, infer T2, infer T3, infer T4, infer R> ? Function3<T2, T3, T4, R> : any >; <T2>(arg2: T2, plc3: LoDashStatic, plc4: LoDashStatic): FunctionChain< T extends Function4<infer T1, T2, infer T3, infer T4, infer R> ? Function3<T1, T3, T4, R> : any >; <T1, T2>( arg1: T1, arg2: T2, plc3: LoDashStatic, plc4: LoDashStatic ): FunctionChain< T extends Function4<T1, T2, infer T3, infer T4, infer R> ? Function2<T3, T4, R> : any >; <T3>(arg3: T3, plc4: LoDashStatic): FunctionChain< T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> : any >; <T1, T3>( arg1: T1, plc2: LoDashStatic, arg3: T3, plc4: LoDashStatic ): FunctionChain< T extends Function4<T1, infer T2, infer T3, infer T4, infer R> ? Function2<T2, T4, R> : any >; <T2, T3>(arg2: T2, arg3: T3, plc4: LoDashStatic): FunctionChain< T extends Function4<infer T1, T2, T3, infer T4, infer R> ? Function2<T1, T4, R> : any >; <T1, T2, T3>( arg1: T1, arg2: T2, arg3: T3, plc4: LoDashStatic ): FunctionChain< T extends Function4<T1, T2, T3, infer T4, infer R> ? Function1<T4, R> : any >; <T4>(arg4: T4): FunctionChain< T extends Function4<infer T1, infer T2, infer T3, T4, infer R> ? Function3<T1, T2, T3, R> : any >; <T1, T4>( arg1: T1, plc2: LoDashStatic, plc3: LoDashStatic, arg4: T4 ): FunctionChain< T extends Function4<T1, infer T2, infer T3, T4, infer R> ? Function2<T2, T3, R> : any >; <T2, T4>(arg2: T2, plc3: LoDashStatic, arg4: T4): FunctionChain< T extends Function4<infer T1, T2, infer T3, T4, infer R> ? Function2<T1, T3, R> : any >; <T1, T2, T4>( arg1: T1, arg2: T2, plc3: LoDashStatic, arg4: T4 ): FunctionChain< T extends Function4<T1, T2, infer T3, T4, infer R> ? Function1<T3, R> : any >; <T3, T4>(arg3: T3, arg4: T4): FunctionChain< T extends Function4<infer T1, infer T2, T3, T4, infer R> ? Function2<T1, T2, R> : any >; <T1, T3, T4>( arg1: T1, plc2: LoDashStatic, arg3: T3, arg4: T4 ): FunctionChain< T extends Function4<T1, infer T2, T3, T4, infer R> ? Function1<T2, R> : any >; <T2, T3, T4>(arg2: T2, arg3: T3, arg4: T4): FunctionChain< T extends Function4<infer T1, T2, T3, T4, infer R> ? Function1<T1, R> : any >; <TS extends any[]>(...ts: TS): FunctionChain< T extends (...args: TS) => infer R ? () => R : any >; (): FunctionChain<T extends (...ts: any[]) => any ? T : any>;};
See Also
_.partialRight
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method rearg
rearg: ( ...indexes: Array<Many<number>>) => FunctionChain<(...args: any[]) => any>;
See Also
_.rearg
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method rest
rest: (start?: number) => FunctionChain<(...args: any[]) => any>;
See Also
_.rest
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method spread
spread: (start?: number) => FunctionChain<(...args: any[]) => ReturnType<T>>;
See Also
_.spread
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method throttle
throttle: { (wait?: number, options?: ThrottleSettingsLeading): T extends ( ...args: any[] ) => any ? FunctionChain<DebouncedFuncLeading<T>> : never; (wait?: number, options?: ThrottleSettings): T extends ( ...args: any[] ) => any ? FunctionChain<DebouncedFunc<T>> : never;};
See Also
_.throttle
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method unary
unary: () => FunctionChain<(arg1: Parameters<T>['0']) => ReturnType<T>>;
See Also
_.unary
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method castArray
castArray: () => CollectionChain<T>;
See Also
_.castArray
interface FunctionChain
interface FunctionChain<T> {}
method flow
flow: { <R2, R3, R4, R5, R6, R7>( f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5, f6: (a: R5) => R6, f7: (a: R6) => R7 ): FunctionChain<(...args: Parameters<T>) => R7>; <R2, R3, R4, R5, R6, R7>( f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5, f6: (a: R5) => R6, f7: (a: R6) => R7, ...func: Many<(a: any) => any>[] ): FunctionChain<(...args: Parameters<T>) => any>; <R2, R3, R4, R5, R6>( f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5, f6: (a: R5) => R6 ): FunctionChain<(...args: Parameters<T>) => R6>; <R2, R3, R4, R5>( f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5 ): FunctionChain<(...args: Parameters<T>) => R5>; <R2, R3, R4>( f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4 ): FunctionChain<(...args: Parameters<T>) => R4>; <R2, R3>(f2: (a: ReturnType<T>) => R2, f3: (a: R2) => R3): FunctionChain< (...args: Parameters<T>) => R3 >; <R2>(f2: (a: ReturnType<T>) => R2): FunctionChain< (...args: Parameters<T>) => R2 >; (...func: Many<(...args: any[]) => any>[]): FunctionChain< (...args: any[]) => any >;};
See Also
_.flow
interface FunctionChain
interface FunctionChain<T> {}
method flowRight
flowRight: { <A extends any[], R1, R2, R3, R4, R5>( f6: (a: R5) => Parameters<T>['0'], f5: (a: R4) => R5, f4: (a: R3) => R4, f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): FunctionChain<(...args: A) => ReturnType<T>>; <A extends any[], R1, R2, R3, R4>( f5: (a: R4) => Parameters<T>['0'], f4: (a: R3) => R4, f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): FunctionChain<(...args: A) => ReturnType<T>>; <A extends any[], R1, R2, R3>( f4: (a: R3) => Parameters<T>['0'], f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): FunctionChain<(...args: A) => ReturnType<T>>; <A extends any[], R1, R2>( f3: (a: R2) => Parameters<T>['0'], f2: (a: R1) => R2, f1: (...args: A) => R1 ): FunctionChain<(...args: A) => ReturnType<T>>; <A extends any[], R1>( f2: (a: R1) => Parameters<T>['0'], f1: (...args: A) => R1 ): FunctionChain<(...args: A) => ReturnType<T>>; <A extends any[]>(f1: (...args: A) => Parameters<T>['0']): FunctionChain< (...args: A) => ReturnType<T> >; (...func: Many<(...args: any[]) => any>[]): FunctionChain< (...args: any[]) => any >;};
See Also
_.flowRight
interface FunctionChain
interface FunctionChain<T extends (...args: any) => any> {}
method iteratee
iteratee: () => FunctionChain<T>;
See Also
_.iteratee
interface FunctionChain
interface FunctionChain<T> {}
method over
over: <TResult>( ...iteratees: Many<(...args: any[]) => TResult>[]) => FunctionChain<(...args: any[]) => Array<ReturnType<T> | TResult>>;
See Also
_.over
interface FunctionChain
interface FunctionChain<T> {}
method overEvery
overEvery: <TArgs>( ...iteratees: Many<(...args: TArgs[]) => boolean>[]) => FunctionChain<(...args: Parameters<T> | TArgs[]) => boolean>;
See Also
_.overEvery
interface FunctionChain
interface FunctionChain<T> {}
method overSome
overSome: <TArgs>( ...iteratees: Many<(...args: TArgs[]) => boolean>[]) => FunctionChain<(...args: Parameters<T> | TArgs[]) => boolean>;
See Also
_.overSome
interface ListOfRecursiveArraysOrValues
interface ListOfRecursiveArraysOrValues<T> extends List<T | RecursiveArray<T>> {}
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method invokeMap
invokeMap: { (methodName: string, ...args: any[]): CollectionChain<any>; <TResult>( method: (...args: any[]) => TResult, ...args: any[] ): CollectionChain<TResult>;};
See Also
_.invokeMap
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method size
size: () => PrimitiveChain<number>;
See Also
_.size
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method now
now: () => PrimitiveChain<number>;
See Also
_.now
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method bind
bind: ( thisArg: any, ...partials: any[]) => FunctionChain<(...args: any[]) => any>;
See Also
_.bind
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method bindKey
bindKey: ( key: string, ...partials: any[]) => FunctionChain<(...args: any[]) => any>;
See Also
_.bindKey
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method defer
defer: (...args: any[]) => PrimitiveChain<number>;
See Also
_.defer
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method delay
delay: (wait: number, ...args: any[]) => PrimitiveChain<number>;
See Also
_.delay
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method wrap
wrap: <TArgs, TResult>( wrapper: (value: TValue, ...args: TArgs[]) => TResult) => FunctionChain<(...args: TArgs[]) => TResult>;
See Also
_.wrap
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method clone
clone: () => this;
See Also
_.clone
method cloneDeep
cloneDeep: () => this;
See Also
_.cloneDeep
method cloneDeepWith
cloneDeepWith: { (customizer: CloneDeepWithCustomizer<TValue>): LoDashExplicitWrapper<any>; (): this;};
See Also
_.cloneDeepWith
method cloneWith
cloneWith: { <TResult extends string | number | boolean | object>( customizer: CloneWithCustomizer<TValue, TResult> ): ExpChain<TResult>; <TResult>(customizer: CloneWithCustomizer<TValue, TResult>): | ExpChain<TValue> | ExpChain<TResult>; (): this;};
See Also
_.cloneWith
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method conformsTo
conformsTo: (source: ConformsPredicateObject<TValue>) => PrimitiveChain<boolean>;
See Also
_.conformsTo
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method eq
eq: (other: any) => PrimitiveChain<boolean>;
See Also
_.eq
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method gt
gt: (other: any) => PrimitiveChain<boolean>;
See Also
_.gt
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method gte
gte: (other: any) => PrimitiveChain<boolean>;
See Also
_.gte
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isArguments
isArguments: () => PrimitiveChain<boolean>;
See Also
_.isArguments
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isArray
isArray: () => PrimitiveChain<boolean>;
See Also
_.isArray
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isArrayBuffer
isArrayBuffer: () => PrimitiveChain<boolean>;
See Also
_.isArrayBuffer
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isArrayLike
isArrayLike: () => PrimitiveChain<boolean>;
See Also
_.isArrayLike
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isArrayLikeObject
isArrayLikeObject: () => PrimitiveChain<boolean>;
See Also
_.isArrayLikeObject
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isBoolean
isBoolean: () => PrimitiveChain<boolean>;
See Also
_.isBoolean
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isBuffer
isBuffer: () => PrimitiveChain<boolean>;
See Also
_.isBuffer
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isDate
isDate: () => PrimitiveChain<boolean>;
See Also
_.isDate
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isElement
isElement: () => PrimitiveChain<boolean>;
See Also
_.isElement
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isEmpty
isEmpty: () => PrimitiveChain<boolean>;
See Also
_.isEmpty
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isEqual
isEqual: (other: any) => PrimitiveChain<boolean>;
See Also
_.isEqual
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isEqualWith
isEqualWith: ( other: any, customizer?: IsEqualCustomizer) => PrimitiveChain<boolean>;
See Also
_.isEqualWith
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isError
isError: () => PrimitiveChain<boolean>;
See Also
_.isError
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isFinite
isFinite: () => PrimitiveChain<boolean>;
See Also
_.isFinite
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isFunction
isFunction: () => PrimitiveChain<boolean>;
See Also
_.isFunction
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isInteger
isInteger: () => PrimitiveChain<boolean>;
See Also
_.isInteger
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isLength
isLength: () => PrimitiveChain<boolean>;
See Also
_.isLength
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isMap
isMap: () => PrimitiveChain<boolean>;
See Also
_.isMap
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isMatch
isMatch: (source: object) => PrimitiveChain<boolean>;
See Also
_.isMatch
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isMatchWith
isMatchWith: ( source: object, customizer: isMatchWithCustomizer) => PrimitiveChain<boolean>;
See Also
_.isMatchWith
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isNaN
isNaN: () => PrimitiveChain<boolean>;
See Also
_.isNaN
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isNative
isNative: () => PrimitiveChain<boolean>;
See Also
_.isNative
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isNil
isNil: () => PrimitiveChain<boolean>;
See Also
_.isNil
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isNull
isNull: () => PrimitiveChain<boolean>;
See Also
_.isNull
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isNumber
isNumber: () => PrimitiveChain<boolean>;
See Also
_.isNumber
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isObject
isObject: () => PrimitiveChain<boolean>;
See Also
_.isObject
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isObjectLike
isObjectLike: () => PrimitiveChain<boolean>;
See Also
_.isObjectLike
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isPlainObject
isPlainObject: () => PrimitiveChain<boolean>;
See Also
_.isPlainObject
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isRegExp
isRegExp: () => PrimitiveChain<boolean>;
See Also
_.isRegExp
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isSafeInteger
isSafeInteger: () => PrimitiveChain<boolean>;
See Also
_.isSafeInteger
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isSet
isSet: () => PrimitiveChain<boolean>;
See Also
_.isSet
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isString
isString: () => PrimitiveChain<boolean>;
See Also
_.isString
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isSymbol
isSymbol: () => PrimitiveChain<boolean>;
See Also
_.isSymbol
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isTypedArray
isTypedArray: () => PrimitiveChain<boolean>;
See Also
_.isTypedArray
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isUndefined
isUndefined: () => PrimitiveChain<boolean>;
See Also
_.isUndefined
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isWeakMap
isWeakMap: () => PrimitiveChain<boolean>;
See Also
_.isWeakMap
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method isWeakSet
isWeakSet: () => PrimitiveChain<boolean>;
See Also
_.isWeakSet
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method lt
lt: (other: any) => PrimitiveChain<boolean>;
See Also
_.lt
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method lte
lte: (other: any) => PrimitiveChain<boolean>;
See Also
_.lte
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toFinite
toFinite: () => PrimitiveChain<number>;
See Also
_.toFinite
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toInteger
toInteger: () => PrimitiveChain<number>;
See Also
_.toInteger
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toLength
toLength: () => PrimitiveChain<number>;
See Also
_.toLength
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toNumber
toNumber: () => PrimitiveChain<number>;
See Also
_.toNumber
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toPlainObject
toPlainObject: () => ObjectChain<any>;
See Also
_.toPlainObject
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toSafeInteger
toSafeInteger: () => PrimitiveChain<number>;
See Also
_.toSafeInteger
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method add
add: (addend: number) => PrimitiveChain<number>;
See Also
_.add
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method ceil
ceil: (precision?: number) => PrimitiveChain<number>;
See Also
_.ceil
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method divide
divide: (divisor: number) => PrimitiveChain<number>;
See Also
_.divide
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method floor
floor: (precision?: number) => PrimitiveChain<number>;
See Also
_.floor
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method mean
mean: () => PrimitiveChain<number>;
See Also
_.mean
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method multiply
multiply: (multiplicand: number) => PrimitiveChain<number>;
See Also
_.multiply
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method round
round: (precision?: number) => PrimitiveChain<number>;
See Also
_.round
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method subtract
subtract: (subtrahend: number) => PrimitiveChain<number>;
See Also
_.subtract
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method sum
sum: () => PrimitiveChain<number>;
See Also
_.sum
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method clamp
clamp: { (lower: number, upper: number): PrimitiveChain<number>; (upper: number): PrimitiveChain<number>;};
See Also
_.clamp
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method inRange
inRange: (start: number, end?: number) => PrimitiveChain<boolean>;
See Also
_.inRange
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method random
random: { (floating?: boolean): PrimitiveChain<number>; (max: number, floating?: boolean): PrimitiveChain<number>;};
See Also
_.random
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method entries
entries: () => CollectionChain<[string, any]>;
See Also
_.entries
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method entriesIn
entriesIn: () => CollectionChain<[string, any]>;
See Also
_.entriesIn
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method findKey
findKey: (predicate?: ObjectIteratee<TValue>) => StringNullableChain;
See Also
_.findKey
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method findLastKey
findLastKey: (predicate?: ObjectIteratee<TValue>) => StringNullableChain;
See Also
_.findLastKey
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method forIn
forIn: (iteratee?: ObjectIterator<TValue, any>) => this;
See Also
_.forIn
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method forInRight
forInRight: (iteratee?: ObjectIterator<TValue, any>) => this;
See Also
_.forInRight
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method forOwn
forOwn: (iteratee?: ObjectIterator<TValue, any>) => this;
See Also
_.forOwn
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method forOwnRight
forOwnRight: (iteratee?: ObjectIterator<TValue, any>) => this;
See Also
_.forOwnRight
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method functions
functions: () => CollectionChain<string>;
See Also
_.functions
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method functionsIn
functionsIn: () => CollectionChain<string>;
See Also
_.functionsIn
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method has
has: (path: PropertyPath) => PrimitiveChain<boolean>;
See Also
_.has
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method hasIn
hasIn: (path: PropertyPath) => PrimitiveChain<boolean>;
See Also
_.hasIn
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method invert
invert: () => ObjectChain<Dictionary<string>>;
See Also
_.invert
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method invoke
invoke: (path: PropertyPath, ...args: any[]) => LoDashExplicitWrapper<any>;
See Also
_.invoke
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method keys
keys: () => CollectionChain<string>;
See Also
_.keys
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method keysIn
keysIn: () => CollectionChain<string>;
See Also
_.keysIn
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method result
result: <TResult>( path: PropertyPath, defaultValue?: TResult | ((...args: any[]) => TResult)) => ExpChain<TResult>;
See Also
_.result
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method set
set: { (path: PropertyPath, value: any): this; <TResult>(path: PropertyPath, value: any): ExpChain<TResult>;};
See Also
_.set
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method setWith
setWith: { ( path: PropertyPath, value: any, customizer?: SetWithCustomizer<TValue> ): this; <TResult>( path: PropertyPath, value: any, customizer?: SetWithCustomizer<TValue> ): ExpChain<TResult>;};
See Also
_.setWith
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toPairs
toPairs: () => CollectionChain< [ string, TValue extends Dictionary<infer U> ? U : TValue extends NumericDictionary<infer V> ? V : any ]>;
See Also
_.toPairs
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toPairsIn
toPairsIn: () => CollectionChain< [ string, TValue extends Dictionary<infer U> ? U : TValue extends NumericDictionary<infer V> ? V : any ]>;
See Also
_.toPairsIn
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method unset
unset: (path: PropertyPath) => PrimitiveChain<boolean>;
See Also
_.unset
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method update
update: (path: PropertyPath, updater: (value: any) => any) => ObjectChain<any>;
See Also
_.update
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method chain
chain: () => this;
See Also
_.chain
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method commit
commit: () => this;
See Also
_.commit
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method plant
plant: (value: unknown) => this;
See Also
_.plant
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method reverse
reverse: () => this;
See Also
_.reverse
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toJSON
toJSON: () => TValue;
See Also
_.toJSON
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method value
value: () => TValue;
See Also
_.value
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method valueOf
valueOf: () => TValue;
See Also
_.valueOf
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method tap
tap: (interceptor: (value: TValue) => void) => this;
See Also
_.tap
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method thru
thru: <TResult>(interceptor: (value: TValue) => TResult) => ExpChain<TResult>;
See Also
_.thru
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method camelCase
camelCase: () => StringChain;
See Also
_.camelCase
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method capitalize
capitalize: () => StringChain< Capitalize<Lowercase<TValue extends string ? TValue : never>>>;
See Also
_.capitalize
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method deburr
deburr: () => StringChain;
See Also
_.deburr
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method endsWith
endsWith: (target?: string, position?: number) => PrimitiveChain<boolean>;
See Also
_.endsWith
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method escape
escape: () => StringChain;
See Also
_.escape
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method escapeRegExp
escapeRegExp: () => StringChain;
See Also
_.escapeRegExp
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method kebabCase
kebabCase: () => StringChain;
See Also
_.kebabCase
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method lowerCase
lowerCase: () => StringChain;
See Also
_.lowerCase
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method lowerFirst
lowerFirst: () => StringChain< TValue extends string ? Uncapitalize<TValue> : string>;
See Also
_.lowerFirst
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method pad
pad: (length?: number, chars?: string) => StringChain;
See Also
_.pad
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method padEnd
padEnd: (length?: number, chars?: string) => StringChain;
See Also
_.padEnd
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method padStart
padStart: (length?: number, chars?: string) => StringChain;
See Also
_.padStart
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method parseInt
parseInt: (radix?: number) => PrimitiveChain<number>;
See Also
_.parseInt
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method repeat
repeat: (n?: number) => StringChain;
See Also
_.repeat
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method replace
replace: { ( pattern: RegExp | string, replacement: ReplaceFunction | string ): StringChain; (replacement: string | ReplaceFunction): StringChain<string>;};
See Also
_.replace
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method snakeCase
snakeCase: () => StringChain;
See Also
_.snakeCase
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method split
split: (separator?: RegExp | string, limit?: number) => CollectionChain<string>;
See Also
_.split
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method startCase
startCase: () => StringChain;
See Also
_.startCase
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method startsWith
startsWith: (target?: string, position?: number) => PrimitiveChain<boolean>;
See Also
_.startsWith
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method template
template: (options?: TemplateOptions) => FunctionChain<TemplateExecutor>;
See Also
_.template
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toLower
toLower: () => StringChain<TValue extends string ? Lowercase<TValue> : string>;
See Also
_.toLower
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toUpper
toUpper: () => StringChain<TValue extends string ? Uppercase<TValue> : string>;
See Also
_.toUpper
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method trim
trim: (chars?: string) => StringChain;
See Also
_.trim
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method trimEnd
trimEnd: (chars?: string) => StringChain;
See Also
_.trimEnd
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method trimStart
trimStart: (chars?: string) => StringChain;
See Also
_.trimStart
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method truncate
truncate: (options?: TruncateOptions) => StringChain;
See Also
_.truncate
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method unescape
unescape: () => StringChain;
See Also
_.unescape
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method upperCase
upperCase: () => StringChain;
See Also
_.upperCase
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method upperFirst
upperFirst: () => StringChain< TValue extends string ? Capitalize<TValue> : string>;
See Also
_.upperFirst
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method words
words: (pattern?: string | RegExp) => CollectionChain<string>;
See Also
_.words
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method attempt
attempt: <TResult>(...args: any[]) => ExpChain<TResult | Error>;
See Also
_.attempt
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method bindAll
bindAll: (...methodNames: Array<Many<string>>) => this;
See Also
_.bindAll
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method conforms
conforms: () => FunctionChain< (value: ConformsPredicateObject<TValue>) => boolean>;
See Also
_.conforms
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method constant
constant: () => FunctionChain<() => TValue>;
See Also
_.constant
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method defaultTo
defaultTo: { (defaultValue: TValue): ExpChain<TValue>; <TDefault>(defaultValue: TDefault): ExpChain< TValue extends null ? TDefault : TValue | TDefault >;};
See Also
_.defaultTo
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method identity
identity: () => this;
See Also
_.identity
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method matches
matches: <V>() => FunctionChain<(value: V) => boolean>;
See Also
_.matches
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method matchesProperty
matchesProperty: { <SrcValue>(srcValue: SrcValue): FunctionChain<(value: any) => boolean>; <SrcValue, Value>(srcValue: SrcValue): FunctionChain< (value: Value) => boolean >;};
See Also
_.matchesProperty
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method method
method: (...args: any[]) => FunctionChain<(object: any) => any>;
See Also
_.method
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method methodOf
methodOf: (...args: any[]) => LoDashExplicitWrapper<(path: PropertyPath) => any>;
See Also
_.methodOf
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method mixin
mixin: { (source: Dictionary<(...args: any[]) => any>, options?: MixinOptions): this; (options?: MixinOptions): LoDashExplicitWrapper<LoDashStatic>;};
See Also
_.mixin
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method noConflict
noConflict: () => LoDashExplicitWrapper<typeof _>;
See Also
_.noConflict
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method noop
noop: (...args: any[]) => PrimitiveChain<undefined>;
See Also
_.noop
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method nthArg
nthArg: () => FunctionChain<(...args: any[]) => any>;
See Also
_.nthArg
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method property
property: <TObj, TResult>() => FunctionChain<(obj: TObj) => TResult>;
See Also
_.property
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method propertyOf
propertyOf: () => LoDashExplicitWrapper<(path: PropertyPath) => any>;
See Also
_.propertyOf
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method range
range: (end?: number, step?: number) => CollectionChain<number>;
See Also
_.range
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method rangeRight
rangeRight: (end?: number, step?: number) => CollectionChain<number>;
See Also
_.rangeRight
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method stubArray
stubArray: () => CollectionChain<any>;
See Also
_.stubArray
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method stubFalse
stubFalse: { (): PrimitiveChain<false>; (): LoDashExplicitWrapper<false> };
See Also
_.stubFalse
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method stubObject
stubObject: () => LoDashExplicitWrapper<any>;
See Also
_.stubObject
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method stubString
stubString: () => StringChain;
See Also
_.stubString
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method stubTrue
stubTrue: { (): PrimitiveChain<true>; (): LoDashExplicitWrapper<true> };
See Also
_.stubTrue
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method times
times: { <TResult>(iteratee: (num: number) => TResult): CollectionChain<TResult>; (): CollectionChain<number>;};
See Also
_.times
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method toPath
toPath: () => CollectionChain<string>;
See Also
_.toPath
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method uniqueId
uniqueId: () => StringChain;
See Also
_.uniqueId
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method stubTrue
stubTrue: { (): PrimitiveChain<true>; (): LoDashExplicitWrapper<true> };
See Also
_.stubTrue
interface LoDashExplicitWrapper
interface LoDashExplicitWrapper<TValue> {}
method stubFalse
stubFalse: { (): PrimitiveChain<false>; (): LoDashExplicitWrapper<false> };
See Also
_.stubFalse
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method invokeMap
invokeMap: { (methodName: string, ...args: any[]): Collection<any>; <TResult>( method: (...args: any[]) => TResult, ...args: any[] ): Collection<TResult>;};
See Also
_.invokeMap
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method size
size: () => number;
See Also
_.size
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method now
now: () => number;
See Also
_.now
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method bind
bind: (thisArg: any, ...partials: any[]) => Function<(...args: any[]) => any>;
See Also
_.bind
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method bindKey
bindKey: (key: string, ...partials: any[]) => Function<(...args: any[]) => any>;
See Also
_.bindKey
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method defer
defer: (...args: any[]) => Primitive<number>;
See Also
_.defer
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method delay
delay: (wait: number, ...args: any[]) => Primitive<number>;
See Also
_.delay
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method wrap
wrap: <TArgs, TResult>( wrapper: (value: TValue, ...args: TArgs[]) => TResult) => Function<(...args: TArgs[]) => TResult>;
See Also
_.wrap
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method clone
clone: () => TValue;
See Also
_.clone
method cloneDeep
cloneDeep: () => TValue;
See Also
_.cloneDeep
method cloneDeepWith
cloneDeepWith: { (customizer: CloneDeepWithCustomizer<TValue>): any; (): TValue;};
See Also
_.cloneDeepWith
method cloneWith
cloneWith: { <TResult extends string | number | boolean | object>( customizer: CloneWithCustomizer<TValue, TResult> ): TResult; <TResult>(customizer: CloneWithCustomizer<TValue, TResult>): | TValue | TResult; (): TValue;};
See Also
_.cloneWith
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method conformsTo
conformsTo: (source: ConformsPredicateObject<TValue>) => boolean;
See Also
_.conformsTo
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method eq
eq: (other: any) => boolean;
See Also
_.eq
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method gt
gt: (other: any) => boolean;
See Also
_.gt
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method gte
gte: (other: any) => boolean;
See Also
_.gte
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isArguments
isArguments: () => boolean;
See Also
_.isArguments
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isArray
isArray: () => boolean;
See Also
_.isArray
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isArrayBuffer
isArrayBuffer: () => boolean;
See Also
_.isArrayBuffer
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isArrayLike
isArrayLike: () => boolean;
See Also
_.isArrayLike
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isArrayLikeObject
isArrayLikeObject: () => boolean;
See Also
_.isArrayLikeObject
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isBoolean
isBoolean: () => boolean;
See Also
_.isBoolean
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isBuffer
isBuffer: () => boolean;
See Also
_.isBuffer
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isDate
isDate: () => boolean;
See Also
_.isDate
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isElement
isElement: () => boolean;
See Also
_.isElement
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isEmpty
isEmpty: () => boolean;
See Also
_.isEmpty
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isEqual
isEqual: (other: any) => boolean;
See Also
_.isEqual
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isEqualWith
isEqualWith: (other: any, customizer?: IsEqualCustomizer) => boolean;
See Also
_.isEqualWith
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isError
isError: () => boolean;
See Also
_.isError
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isFinite
isFinite: () => boolean;
See Also
_.isFinite
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isFunction
isFunction: () => boolean;
See Also
_.isFunction
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isInteger
isInteger: () => boolean;
See Also
_.isInteger
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isLength
isLength: () => boolean;
See Also
_.isLength
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isMap
isMap: () => boolean;
See Also
_.isMap
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isMatch
isMatch: (source: object) => boolean;
See Also
_.isMatch
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isMatchWith
isMatchWith: (source: object, customizer: isMatchWithCustomizer) => boolean;
See Also
_.isMatchWith
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isNaN
isNaN: () => boolean;
See Also
_.isNaN
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isNative
isNative: () => boolean;
See Also
_.isNative
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isNil
isNil: () => boolean;
See Also
_.isNil
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isNull
isNull: () => boolean;
See Also
_.isNull
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isNumber
isNumber: () => boolean;
See Also
_.isNumber
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isObject
isObject: () => this is LoDashImplicitWrapper<object>;
See Also
_.isObject
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isObjectLike
isObjectLike: () => boolean;
See Also
_.isObjectLike
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isPlainObject
isPlainObject: () => boolean;
See Also
_.isPlainObject
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isRegExp
isRegExp: () => boolean;
See Also
_.isRegExp
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isSafeInteger
isSafeInteger: () => boolean;
See Also
_.isSafeInteger
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isSet
isSet: () => boolean;
See Also
_.isSet
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isString
isString: () => boolean;
See Also
_.isString
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isSymbol
isSymbol: () => boolean;
See Also
_.isSymbol
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isTypedArray
isTypedArray: () => boolean;
See Also
_.isTypedArray
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isUndefined
isUndefined: () => boolean;
See Also
_.isUndefined
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isWeakMap
isWeakMap: () => boolean;
See Also
_.isWeakMap
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method isWeakSet
isWeakSet: () => boolean;
See Also
_.isWeakSet
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method lt
lt: (other: any) => boolean;
See Also
_.lt
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method lte
lte: (other: any) => boolean;
See Also
_.lte
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toFinite
toFinite: () => number;
See Also
_.toFinite
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toInteger
toInteger: () => number;
See Also
_.toInteger
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toLength
toLength: () => number;
See Also
_.toLength
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toNumber
toNumber: () => number;
See Also
_.toNumber
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toPlainObject
toPlainObject: () => Object<any>;
See Also
_.toPlainObject
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toSafeInteger
toSafeInteger: () => number;
See Also
_.toSafeInteger
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method add
add: (addend: number) => number;
See Also
_.add
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method ceil
ceil: (precision?: number) => number;
See Also
_.ceil
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method divide
divide: (divisor: number) => number;
See Also
_.divide
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method floor
floor: (precision?: number) => number;
See Also
_.floor
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method mean
mean: () => number;
See Also
_.mean
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method multiply
multiply: (multiplicand: number) => number;
See Also
_.multiply
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method round
round: (precision?: number) => number;
See Also
_.round
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method subtract
subtract: (subtrahend: number) => number;
See Also
_.subtract
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method sum
sum: () => number;
See Also
_.sum
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method clamp
clamp: { (lower: number, upper: number): number; (upper: number): number };
See Also
_.clamp
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method inRange
inRange: (start: number, end?: number) => boolean;
See Also
_.inRange
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method random
random: { (floating?: boolean): number; (max: number, floating?: boolean): number;};
See Also
_.random
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method entries
entries: () => Collection<[string, any]>;
See Also
_.entries
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method entriesIn
entriesIn: () => Collection<[string, any]>;
See Also
_.entriesIn
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method findKey
findKey: (predicate?: ObjectIteratee<TValue>) => string | undefined;
See Also
_.findKey
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method findLastKey
findLastKey: (predicate?: ObjectIteratee<TValue>) => string | undefined;
See Also
_.findLastKey
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method forIn
forIn: (iteratee?: ObjectIterator<TValue, any>) => this;
See Also
_.forIn
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method forInRight
forInRight: (iteratee?: ObjectIterator<TValue, any>) => this;
See Also
_.forInRight
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method forOwn
forOwn: (iteratee?: ObjectIterator<TValue, any>) => this;
See Also
_.forOwn
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method forOwnRight
forOwnRight: (iteratee?: ObjectIterator<TValue, any>) => this;
See Also
_.forOwnRight
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method functions
functions: () => Collection<string>;
See Also
_.functions
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method functionsIn
functionsIn: () => Collection<string>;
See Also
_.functionsIn
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method has
has: (path: PropertyPath) => boolean;
See Also
_.has
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method hasIn
hasIn: (path: PropertyPath) => boolean;
See Also
_.hasIn
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method invert
invert: () => Object<Dictionary<string>>;
See Also
_.invert
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method invoke
invoke: (path: PropertyPath, ...args: any[]) => any;
See Also
_.invoke
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method keys
keys: () => Collection<string>;
See Also
_.keys
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method keysIn
keysIn: () => Collection<string>;
See Also
_.keysIn
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method result
result: <TResult>( path: PropertyPath, defaultValue?: TResult | ((...args: any[]) => TResult)) => TResult;
See Also
_.result
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method set
set: { (path: PropertyPath, value: any): this; <TResult>(path: PropertyPath, value: any): ImpChain<TResult>;};
See Also
_.set
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method setWith
setWith: { ( path: PropertyPath, value: any, customizer?: SetWithCustomizer<TValue> ): this; <TResult>( path: PropertyPath, value: any, customizer?: SetWithCustomizer<TValue> ): ImpChain<TResult>;};
See Also
_.setWith
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toPairs
toPairs: () => Collection< [ string, TValue extends Dictionary<infer U> ? U : TValue extends NumericDictionary<infer V> ? V : any ]>;
See Also
_.toPairs
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toPairsIn
toPairsIn: () => Collection< [ string, TValue extends Dictionary<infer U> ? U : TValue extends NumericDictionary<infer V> ? V : any ]>;
See Also
_.toPairsIn
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method unset
unset: (path: PropertyPath) => Primitive<boolean>;
See Also
_.unset
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method update
update: (path: PropertyPath, updater: (value: any) => any) => Object<any>;
See Also
_.update
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method commit
commit: () => this;
See Also
_.commit
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method plant
plant: (value: unknown) => this;
See Also
_.plant
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method reverse
reverse: () => this;
See Also
_.reverse
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toJSON
toJSON: () => TValue;
See Also
_.toJSON
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method value
value: () => TValue;
See Also
_.value
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method valueOf
valueOf: () => TValue;
See Also
_.valueOf
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method tap
tap: (interceptor: (value: TValue) => void) => this;
See Also
_.tap
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method thru
thru: <TResult>(interceptor: (value: TValue) => TResult) => ImpChain<TResult>;
See Also
_.thru
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method camelCase
camelCase: () => string;
See Also
_.camelCase
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method capitalize
capitalize: () => Capitalize<Lowercase<TValue extends string ? TValue : never>>;
See Also
_.capitalize
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method deburr
deburr: () => string;
See Also
_.deburr
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method endsWith
endsWith: (target?: string, position?: number) => boolean;
See Also
_.endsWith
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method escape
escape: () => string;
See Also
_.escape
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method escapeRegExp
escapeRegExp: () => string;
See Also
_.escapeRegExp
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method kebabCase
kebabCase: () => string;
See Also
_.kebabCase
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method lowerCase
lowerCase: () => string;
See Also
_.lowerCase
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method lowerFirst
lowerFirst: () => TValue extends string ? Uncapitalize<TValue> : string;
See Also
_.lowerFirst
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method pad
pad: (length?: number, chars?: string) => string;
See Also
_.pad
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method padEnd
padEnd: (length?: number, chars?: string) => string;
See Also
_.padEnd
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method padStart
padStart: (length?: number, chars?: string) => string;
See Also
_.padStart
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method parseInt
parseInt: (radix?: number) => number;
See Also
_.parseInt
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method repeat
repeat: (n?: number) => string;
See Also
_.repeat
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method replace
replace: { (pattern: RegExp | string, replacement: ReplaceFunction | string): string; (replacement: string | ReplaceFunction): string;};
See Also
_.replace
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method snakeCase
snakeCase: () => string;
See Also
_.snakeCase
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method split
split: (separator?: RegExp | string, limit?: number) => Collection<string>;
See Also
_.split
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method startCase
startCase: () => string;
See Also
_.startCase
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method startsWith
startsWith: (target?: string, position?: number) => boolean;
See Also
_.startsWith
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method template
template: (options?: TemplateOptions) => TemplateExecutor;
See Also
_.template
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toLower
toLower: () => TValue extends string ? Lowercase<TValue> : string;
See Also
_.toLower
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toUpper
toUpper: () => TValue extends string ? Uppercase<TValue> : string;
See Also
_.toUpper
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method trim
trim: (chars?: string) => string;
See Also
_.trim
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method trimEnd
trimEnd: (chars?: string) => string;
See Also
_.trimEnd
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method trimStart
trimStart: (chars?: string) => string;
See Also
_.trimStart
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method truncate
truncate: (options?: TruncateOptions) => string;
See Also
_.truncate
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method unescape
unescape: () => string;
See Also
_.unescape
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method upperCase
upperCase: () => string;
See Also
_.upperCase
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method upperFirst
upperFirst: () => TValue extends string ? Capitalize<TValue> : string;
See Also
_.upperFirst
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method words
words: (pattern?: string | RegExp) => Collection<string>;
See Also
_.words
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method attempt
attempt: <TResult>(...args: any[]) => TResult | Error;
See Also
_.attempt
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method bindAll
bindAll: (...methodNames: Array<Many<string>>) => this;
See Also
_.bindAll
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method conforms
conforms: () => Function<(value: ConformsPredicateObject<TValue>) => boolean>;
See Also
_.conforms
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method constant
constant: () => Function<() => TValue>;
See Also
_.constant
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method defaultTo
defaultTo: { (defaultValue: TValue): TValue; <TDefault>(defaultValue: TDefault): TValue extends null ? TDefault : TValue | TDefault;};
See Also
_.defaultTo
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method identity
identity: () => TValue;
See Also
_.identity
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method matches
matches: <V>() => Function<(value: V) => boolean>;
See Also
_.matches
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method matchesProperty
matchesProperty: { <SrcValue>(srcValue: SrcValue): Function<(value: any) => boolean>; <SrcValue, Value>(srcValue: SrcValue): Function<(value: Value) => boolean>;};
See Also
_.matchesProperty
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method method
method: (...args: any[]) => Function<(object: any) => any>;
See Also
_.method
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method methodOf
methodOf: (...args: any[]) => LoDashImplicitWrapper<(path: PropertyPath) => any>;
See Also
_.methodOf
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method mixin
mixin: { (source: Dictionary<(...args: any[]) => any>, options?: MixinOptions): this; (options?: MixinOptions): LoDashImplicitWrapper<LoDashStatic>;};
See Also
_.mixin
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method noConflict
noConflict: () => typeof _;
See Also
_.noConflict
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method noop
noop: (...args: any[]) => void;
See Also
_.noop
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method nthArg
nthArg: () => Function<(...args: any[]) => any>;
See Also
_.nthArg
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method property
property: <TObj, TResult>() => Function<(obj: TObj) => TResult>;
See Also
_.property
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method propertyOf
propertyOf: () => LoDashImplicitWrapper<(path: PropertyPath) => any>;
See Also
_.propertyOf
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method range
range: (end?: number, step?: number) => Collection<number>;
See Also
_.range
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method rangeRight
rangeRight: (end?: number, step?: number) => Collection<number>;
See Also
_.rangeRight
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method runInContext
runInContext: () => LoDashStatic;
See Also
_.runInContext
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method stubArray
stubArray: () => any[];
See Also
_.stubArray
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method stubFalse
stubFalse: { (): false; (): false };
See Also
_.stubFalse
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method stubObject
stubObject: () => any;
See Also
_.stubObject
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method stubString
stubString: () => string;
See Also
_.stubString
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method stubTrue
stubTrue: { (): true; (): true };
See Also
_.stubTrue
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method times
times: { <TResult>(iteratee: (num: number) => TResult): TResult[]; (): number[];};
See Also
_.times
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method toPath
toPath: () => Collection<string>;
See Also
_.toPath
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method uniqueId
uniqueId: () => string;
See Also
_.uniqueId
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method stubTrue
stubTrue: { (): true; (): true };
See Also
_.stubTrue
interface LoDashImplicitWrapper
interface LoDashImplicitWrapper<TValue> {}
method stubFalse
stubFalse: { (): false; (): false };
See Also
_.stubFalse
interface LoDashStatic
interface LoDashStatic {}
interface LoDashStatic
interface LoDashStatic {}
property templateSettings
templateSettings: TemplateSettings;
By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby (ERB). Change the following template settings to use alternative delimiters.
property VERSION
VERSION: string;
The semantic version number.
call signature
<TrapAny extends { __trapAny: any }>(value: TrapAny): Collection<any> & Function<any> & Object<any> & Primitive<any> & String;
Creates a lodash object which wraps value to enable implicit method chain sequences. Methods that operate on and return arrays, collections, and functions can be chained together. Methods that retrieve a single value or may return a primitive value will automatically end the chain sequence and return the unwrapped value. Otherwise, the value must be unwrapped with value().
Explicit chain sequences, which must be unwrapped with value(), may be enabled using _.chain.
The execution of chained methods is lazy, that is, it's deferred until value() is implicitly or explicitly called.
Lazy evaluation allows several methods to support shortcut fusion. Shortcut fusion is an optimization to merge iteratee calls; this avoids the creation of intermediate arrays and can greatly reduce the number of iteratee executions. Sections of a chain sequence qualify for shortcut fusion if the section is applied to an array and iteratees accept only one argument. The heuristic for whether a section qualifies for shortcut fusion is subject to change.
Chaining is supported in custom builds as long as the value() method is directly or indirectly included in the build.
In addition to lodash methods, wrappers have Array and String methods. The wrapper Array methods are: concat, join, pop, push, shift, sort, splice, and unshift. The wrapper String methods are: replace and split.
The wrapper methods that support shortcut fusion are: at, compact, drop, dropRight, dropWhile, filter, find, findLast, head, initial, last, map, reject, reverse, slice, tail, take, takeRight, takeRightWhile, takeWhile, and toArray
The chainable wrapper methods are: after, ary, assign, assignIn, assignInWith, assignWith, at, before, bind, bindAll, bindKey, castArray, chain, chunk, commit, compact, concat, conforms, constant, countBy, create, curry, debounce, defaults, defaultsDeep, defer, delay, difference, differenceBy, differenceWith, drop, dropRight, dropRightWhile, dropWhile, extend, extendWith, fill, filter, flatMap, flatMapDeep, flatMapDepth, flatten, flattenDeep, flattenDepth, flip, flow, flowRight, fromPairs, functions, functionsIn, groupBy, initial, intersection, intersectionBy, intersectionWith, invert, invertBy, invokeMap, iteratee, keyBy, keys, keysIn, map, mapKeys, mapValues, matches, matchesProperty, memoize, merge, mergeWith, method, methodOf, mixin, negate, nthArg, omit, omitBy, once, orderBy, over, overArgs, overEvery, overSome, partial, partialRight, partition, pick, pickBy, plant, property, propertyOf, pull, pullAll, pullAllBy, pullAllWith, pullAt, push, range, rangeRight, rearg, reject, remove, rest, reverse, sampleSize, set, setWith, shuffle, slice, sort, sortBy, sortedUniq, sortedUniqBy, splice, spread, tail, take, takeRight, takeRightWhile, takeWhile, tap, throttle, thru, toArray, toPairs, toPairsIn, toPath, toPlainObject, transform, unary, union, unionBy, unionWith, uniq, uniqBy, uniqWith, unset, unshift, unzip, unzipWith, update, updateWith, values, valuesIn, without, wrap, xor, xorBy, xorWith, zip, zipObject, zipObjectDeep, and zipWith.
The wrapper methods that are not chainable by default are: add, attempt, camelCase, capitalize, ceil, clamp, clone, cloneDeep, cloneDeepWith, cloneWith, conformsTo, deburr, defaultTo, divide, each, eachRight, endsWith, eq, escape, escapeRegExp, every, find, findIndex, findKey, findLast, findLastIndex, findLastKey, first, floor, forEach, forEachRight, forIn, forInRight, forOwn, forOwnRight, get, gt, gte, has, hasIn, head, identity, includes, indexOf, inRange, invoke, isArguments, isArray, isArrayBuffer, isArrayLike, isArrayLikeObject, isBoolean, isBuffer, isDate, isElement, isEmpty, isEqual, isEqualWith, isError, isFinite, isFunction, isInteger, isLength, isMap, isMatch, isMatchWith, isNaN, isNative, isNil, isNull, isNumber, isObject, isObjectLike, isPlainObject, isRegExp, isSafeInteger, isSet, isString, isUndefined, isTypedArray, isWeakMap, isWeakSet, join, kebabCase, last, lastIndexOf, lowerCase, lowerFirst, lt, lte, max, maxBy, mean, meanBy, min, minBy, multiply, noConflict, noop, now, nth, pad, padEnd, padStart, parseInt, pop, random, reduce, reduceRight, repeat, result, round, runInContext, sample, shift, size, snakeCase, some, sortedIndex, sortedIndexBy, sortedLastIndex, sortedLastIndexBy, startCase, startsWith, stubArray, stubFalse, stubObject, stubString, stubTrue, subtract, sum, sumBy, template, times, toFinite, toInteger, toJSON, toLength, toLower, toNumber, toSafeInteger, toString, toUpper, trim, trimEnd, trimStart, truncate, unescape, uniqueId, upperCase, upperFirst, value, and words.
call signature
<T extends string>(value: T): String<T>;
call signature
<T extends null | undefined>(value: T): Primitive<T>;
call signature
(value: string | null | undefined): String;
call signature
<T extends (...args: any) => any>(value: T): Function<T>;
call signature
<T = any>(value: List<T> | null | undefined): Collection<T>;
call signature
<T extends object>(value: T | null | undefined): Object<T>;
call signature
<T>(value: T): Primitive<T>;
interface LoDashStatic
interface LoDashStatic {}
method chunk
chunk: <T>(array: List<T> | null | undefined, size?: number) => T[][];
Creates an array of elements split into groups the length of size. If collection can’t be split evenly, the final chunk will be the remaining elements.
Parameter array
The array to process.
Parameter size
The length of each chunk. Returns the new array containing chunks.
interface LoDashStatic
interface LoDashStatic {}
method compact
compact: <T>(array: List<T | Falsey> | null | undefined) => T[];
Creates an array with all falsey values removed. The values false, null, 0, 0n, "", undefined, and NaN are falsey.
Parameter array
The array to compact. Returns the new array of filtered values.
interface LoDashStatic
interface LoDashStatic {}
method concat
concat: <T>(...values: Array<Many<T>>) => T[];
Creates a new array concatenating
array
with any additional arrays and/or values.Array
Parameter values
The array values to concatenate.
Returns
Returns the new concatenated array.
Example 1
var array = [1]; var other = _.concat(array, 2, [3], [[4]]);
console.log(other); // => [1, 2, 3, [4]]
console.log(array); // => [1]
interface LoDashStatic
interface LoDashStatic {}
method difference
difference: <T>( array: List<T> | null | undefined, ...values: Array<List<T>>) => T[];
Creates an array of
array
values not included in the other provided arrays using SameValueZero for equality comparisons. The order and references of result values are determined by the first array.Parameter array
The array to inspect.
Parameter values
The arrays of values to exclude. Returns the new array of filtered values.
interface LoDashStatic
interface LoDashStatic {}
method differenceBy
differenceBy: { <T1, T2>( array: List<T1> | null | undefined, values: List<T2>, iteratee: ValueIteratee<T1 | T2> ): T1[]; <T1, T2, T3>( array: List<T1>, values1: List<T2>, values2: List<T3>, iteratee: ValueIteratee<T1 | T2 | T3> ): T1[]; <T1, T2, T3, T4>( array: List<T1>, values1: List<T2>, values2: List<T3>, values3: List<T4>, iteratee: ValueIteratee<T1 | T2 | T3 | T4> ): T1[]; <T1, T2, T3, T4, T5>( array: List<T1>, values1: List<T2>, values2: List<T3>, values3: List<T4>, values4: List<T5>, iteratee: ValueIteratee<T1 | T2 | T3 | T4 | T5> ): T1[]; <T1, T2, T3, T4, T5, T6>( array: List<T1>, values1: List<T2>, values2: List<T3>, values3: List<T4>, values4: List<T5>, values5: List<T6>, iteratee: ValueIteratee<T1 | T2 | T3 | T4 | T5 | T6> ): T1[]; <T1, T2, T3, T4, T5, T6, T7>( array: List<T1>, values1: List<T2>, values2: List<T3>, values3: List<T4>, values4: List<T5>, values5: List<T6>, ...values: (List<T7> | ValueIteratee<T1 | T2 | T3 | T4 | T5 | T6 | T7>)[] ): T1[]; <T>(array: List<T>, ...values: List<T>[]): T[];};
This method is like _.difference except that it accepts iteratee which is invoked for each element of array and values to generate the criterion by which they're compared. The order and references of result values are determined by the first array. The iteratee is invoked with one argument: (value).
Parameter array
The array to inspect.
Parameter values
The values to exclude.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the new array of filtered values.
See Also
_.differenceBy
interface LoDashStatic
interface LoDashStatic {}
method differenceWith
differenceWith: { <T1, T2>( array: List<T1> | null | undefined, values: List<T2>, comparator: Comparator2<T1, T2> ): T1[]; <T1, T2, T3>( array: List<T1>, values1: List<T2>, values2: List<T3>, comparator: Comparator2<T1, T2 | T3> ): T1[]; <T1, T2, T3, T4>( array: List<T1>, values1: List<T2>, values2: List<T3>, ...values: (List<T4> | Comparator2<T1, T2 | T3 | T4>)[] ): T1[]; <T>(array: List<T>, ...values: List<T>[]): T[];};
This method is like _.difference except that it accepts comparator which is invoked to compare elements of array to values. The order and references of result values are determined by the first array. The comparator is invoked with two arguments: (arrVal, othVal).
Array
Parameter values
The arrays to inspect.
Parameter comparator
The comparator invoked per element.
Returns
Returns the new array of filtered values.
Example 1
var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
_.differenceWith(objects, [{ 'x': 1, 'y': 2 }], _.isEqual); // => [{ 'x': 2, 'y': 1 }]
See Also
_.differenceWith
interface LoDashStatic
interface LoDashStatic {}
method drop
drop: <T>(array: List<T> | null | undefined, n?: number) => T[];
Creates a slice of array with n elements dropped from the beginning.
Parameter array
The array to query.
Parameter n
The number of elements to drop. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method dropRight
dropRight: <T>(array: List<T> | null | undefined, n?: number) => T[];
Creates a slice of array with n elements dropped from the end.
Parameter array
The array to query.
Parameter n
The number of elements to drop. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method dropRightWhile
dropRightWhile: <T>( array: List<T> | null | undefined, predicate?: ListIteratee<T>) => T[];
Creates a slice of array excluding elements dropped from the end. Elements are dropped until predicate returns falsey. The predicate is invoked with three arguments: (value, index, array).
Parameter array
The array to query.
Parameter predicate
The function invoked per iteration. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method dropWhile
dropWhile: <T>( array: List<T> | null | undefined, predicate?: ListIteratee<T>) => T[];
Creates a slice of array excluding elements dropped from the beginning. Elements are dropped until predicate returns falsey. The predicate is invoked with three arguments: (value, index, array).
Parameter array
The array to query.
Parameter predicate
The function invoked per iteration. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method fill
fill: { <T>(array: any[] | null | undefined, value: T): T[]; <T>(array: List<any>, value: T): List<T>; <T, U>(array: U[], value: T, start?: number, end?: number): (T | U)[]; <T, U>(array: List<U>, value: T, start?: number, end?: number): List<T | U>;};
Fills elements of array with value from start up to, but not including, end.
Note: This method mutates array.
Parameter array
The array to fill.
Parameter value
The value to fill array with.
Parameter start
The start position.
Parameter end
The end position. Returns array.
See Also
_.fill
interface LoDashStatic
interface LoDashStatic {}
method findIndex
findIndex: <T>( array: List<T> | null | undefined, predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number) => number;
This method is like _.find except that it returns the index of the first element predicate returns truthy for instead of the element itself.
Parameter array
The array to search.
Parameter predicate
The function invoked per iteration.
Parameter fromIndex
The index to search from. Returns the index of the found element, else -1.
interface LoDashStatic
interface LoDashStatic {}
method findLastIndex
findLastIndex: <T>( array: List<T> | null | undefined, predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number) => number;
This method is like _.findIndex except that it iterates over elements of collection from right to left.
Parameter array
The array to search.
Parameter predicate
The function invoked per iteration.
Parameter fromIndex
The index to search from. Returns the index of the found element, else -1.
interface LoDashStatic
interface LoDashStatic {}
property first
first: LoDashStatic['head'];
See Also
_.head
interface LoDashStatic
interface LoDashStatic {}
method flatten
flatten: <T>(array: List<Many<T>> | null | undefined) => T[];
Flattens
array
a single level deep.Parameter array
The array to flatten. Returns the new flattened array.
interface LoDashStatic
interface LoDashStatic {}
method flattenDeep
flattenDeep: <T>( array: ListOfRecursiveArraysOrValues<T> | null | undefined) => Array<Flat<T>>;
Recursively flattens a nested array.
Parameter array
The array to recursively flatten. Returns the new flattened array.
interface LoDashStatic
interface LoDashStatic {}
method flattenDepth
flattenDepth: <T>( array: ListOfRecursiveArraysOrValues<T> | null | undefined, depth?: number) => T[];
Recursively flatten array up to depth times.
Parameter array
The array to recursively flatten.
Parameter number
The maximum recursion depth. Returns the new flattened array.
interface LoDashStatic
interface LoDashStatic {}
method fromPairs
fromPairs: { <T>(pairs: List<[PropertyName, T]> | null | undefined): Dictionary<T>; (pairs: List<any[]>): Dictionary<any>;};
The inverse of
_.toPairs
; this method returns an object composed from key-valuepairs
.Array
Parameter pairs
The key-value pairs.
Returns
Returns the new object.
Example 1
_.fromPairs([['fred', 30], ['barney', 40]]); // => { 'fred': 30, 'barney': 40 }
See Also
_.fromPairs
interface LoDashStatic
interface LoDashStatic {}
method head
head: { <T>(array: readonly [T, ...unknown[]]): T; <T>(array: List<T>): T };
Gets the first element of array.
_.first
Parameter array
The array to query. Returns the first element of array.
interface LoDashStatic
interface LoDashStatic {}
method indexOf
indexOf: <T>( array: List<T> | null | undefined, value: T, fromIndex?: number) => number;
Gets the index at which the first occurrence of
value
is found inarray
using [SameValueZero
](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero) for equality comparisons. IffromIndex
is negative, it's used as the offset from the end ofarray
.Array
Parameter array
The array to search.
Parameter value
The value to search for.
Parameter fromIndex
The index to search from.
Returns
Returns the index of the matched value, else
-1
.Example 1
_.indexOf([1, 2, 1, 2], 2); // => 1
// using
fromIndex
_.indexOf([1, 2, 1, 2], 2, 2); // => 3
interface LoDashStatic
interface LoDashStatic {}
method initial
initial: <T>(array: List<T> | null | undefined) => T[];
Gets all but the last element of array.
Parameter array
The array to query. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method intersection
intersection: <T>(...arrays: Array<List<T> | null | undefined>) => T[];
Creates an array of unique values that are included in all of the provided arrays using SameValueZero for equality comparisons.
Parameter arrays
The arrays to inspect. Returns the new array of shared values.
interface LoDashStatic
interface LoDashStatic {}
method intersectionBy
intersectionBy: { <T1, T2>( array: List<T1> | null, values: List<T2>, iteratee: ValueIteratee<T1 | T2> ): T1[]; <T1, T2, T3>( array: List<T1>, values1: List<T2>, values2: List<T3>, iteratee: ValueIteratee<T1 | T2 | T3> ): T1[]; <T1, T2, T3, T4>( array: List<T1>, values1: List<T2>, values2: List<T3>, ...values: (List<T4> | ValueIteratee<T1 | T2 | T3 | T4>)[] ): T1[]; <T>(array?: List<T>, ...values: List<T>[]): T[]; <T>(...values: (List<T> | ValueIteratee<T>)[]): T[];};
This method is like
_.intersection
except that it acceptsiteratee
which is invoked for each element of eacharrays
to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).Array
Parameter arrays
The arrays to inspect.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the new array of shared values.
Example 1
_.intersectionBy([2.1, 1.2], [4.3, 2.4], Math.floor); // => [2.1]
// using the
_.property
iteratee shorthand _.intersectionBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x'); // => [{ 'x': 1 }]See Also
_.intersectionBy
interface LoDashStatic
interface LoDashStatic {}
method intersectionWith
intersectionWith: { <T1, T2>( array: List<T1> | null | undefined, values: List<T2>, comparator: Comparator2<T1, T2> ): T1[]; <T1, T2, T3>( array: List<T1>, values1: List<T2>, values2: List<T3>, comparator: Comparator2<T1, T2 | T3> ): T1[]; <T1, T2, T3, T4>( array: List<T1>, values1: List<T2>, values2: List<T3>, ...values: (List<T4> | Comparator2<T1, T2 | T3 | T4>)[] ): T1[]; <T>(array?: List<T>, ...values: (List<T> | Comparator2<T, never>)[]): T[];};
Creates an array of unique
array
values not included in the other provided arrays using [SameValueZero
](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero) for equality comparisons.Array
Parameter values
The arrays to inspect.
Parameter comparator
The comparator invoked per element.
Returns
Returns the new array of filtered values.
Example 1
var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];
_.intersectionWith(objects, others, _.isEqual); // => [{ 'x': 1, 'y': 2 }]
See Also
_.intersectionWith
interface LoDashStatic
interface LoDashStatic {}
method join
join: (array: List<any> | null | undefined, separator?: string) => string;
Converts all elements in
array
into a string separated byseparator
.Parameter array
The array to convert.
Parameter separator
The element separator.
Returns
Returns the joined string.
interface LoDashStatic
interface LoDashStatic {}
method last
last: <T>(array: List<T> | null | undefined) => T | undefined;
Gets the last element of array.
Parameter array
The array to query. Returns the last element of array.
interface LoDashStatic
interface LoDashStatic {}
method lastIndexOf
lastIndexOf: <T>( array: List<T> | null | undefined, value: T, fromIndex?: true | number) => number;
This method is like _.indexOf except that it iterates over elements of array from right to left.
Parameter array
The array to search.
Parameter value
The value to search for.
Parameter fromIndex
The index to search from or true to perform a binary search on a sorted array. Returns the index of the matched value, else -1.
interface LoDashStatic
interface LoDashStatic {}
method nth
nth: <T>(array: List<T> | null | undefined, n?: number) => T | undefined;
Gets the element at index
n
ofarray
. Ifn
is negative, the nth element from the end is returned.Parameter array
array The array to query.
Parameter value
The index of the element to return. Returns the nth element of
array
.
interface LoDashStatic
interface LoDashStatic {}
method pull
pull: { <T>(array: T[], ...values: T[]): T[]; <T>(array: List<T>, ...values: T[]): List<T>;};
Removes all provided values from array using SameValueZero for equality comparisons.
Note: Unlike _.without, this method mutates array.
Parameter array
The array to modify.
Parameter values
The values to remove. Returns array.
See Also
_.pull
interface LoDashStatic
interface LoDashStatic {}
method pullAll
pullAll: { <T>(array: T[], values?: List<T>): T[]; <T>(array: List<T>, values?: List<T>): List<T>;};
This method is like
_.pull
except that it accepts an array of values to remove.**Note:** Unlike
_.difference
, this method mutatesarray
.Array
Parameter array
The array to modify.
Parameter values
The values to remove.
Returns
Returns
array
.Example 1
var array = [1, 2, 3, 1, 2, 3];
_.pull(array, [2, 3]); console.log(array); // => [1, 1]
See Also
_.pullAll
interface LoDashStatic
interface LoDashStatic {}
method pullAllBy
pullAllBy: { <T>(array: T[], values?: List<T>, iteratee?: ValueIteratee<T>): T[]; <T>(array: List<T>, values?: List<T>, iteratee?: ValueIteratee<T>): List<T>; <T1, T2>( array: T1[], values: List<T2>, iteratee: ValueIteratee<T1 | T2> ): T1[]; <T1, T2>( array: List<T1>, values: List<T2>, iteratee: ValueIteratee<T1 | T2> ): List<T1>;};
This method is like
_.pullAll
except that it acceptsiteratee
which is invoked for each element ofarray
andvalues
to to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).**Note:** Unlike
_.differenceBy
, this method mutatesarray
.Array
Parameter array
The array to modify.
Parameter values
The values to remove.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns
array
.Example 1
var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];
_.pullAllBy(array, [{ 'x': 1 }, { 'x': 3 }], 'x'); console.log(array); // => [{ 'x': 2 }]
See Also
_.pullAllBy
interface LoDashStatic
interface LoDashStatic {}
method pullAllWith
pullAllWith: { <T>(array: T[], values?: List<T>, comparator?: Comparator<T>): T[]; <T>(array: List<T>, values?: List<T>, comparator?: Comparator<T>): List<T>; <T1, T2>( array: T1[], values: List<T2>, comparator: Comparator2<T1, T2> ): T1[]; <T1, T2>( array: List<T1>, values: List<T2>, comparator: Comparator2<T1, T2> ): List<T1>;};
This method is like
_.pullAll
except that it acceptscomparator
which is invoked to compare elements of array to values. The comparator is invoked with two arguments: (arrVal, othVal).**Note:** Unlike
_.differenceWith
, this method mutatesarray
.Array
Parameter array
The array to modify.
Parameter values
The values to remove.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns
array
.Example 1
var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];
_.pullAllWith(array, [{ 'x': 3, 'y': 4 }], _.isEqual); console.log(array); // => [{ 'x': 1, 'y': 2 }, { 'x': 5, 'y': 6 }]
See Also
_.pullAllWith
interface LoDashStatic
interface LoDashStatic {}
method pullAt
pullAt: { <T>(array: T[], ...indexes: Array<Many<number>>): T[]; <T>(array: List<T>, ...indexes: Many<number>[]): List<T>;};
Removes elements from array corresponding to the given indexes and returns an array of the removed elements. Indexes may be specified as an array of indexes or as individual arguments.
Note: Unlike _.at, this method mutates array.
Parameter array
The array to modify.
Parameter indexes
The indexes of elements to remove, specified as individual indexes or arrays of indexes. Returns the new array of removed elements.
See Also
_.pullAt
interface LoDashStatic
interface LoDashStatic {}
method remove
remove: <T>(array: List<T>, predicate?: ListIteratee<T>) => T[];
Removes all elements from array that predicate returns truthy for and returns an array of the removed elements. The predicate is invoked with three arguments: (value, index, array).
Note: Unlike _.filter, this method mutates array.
Parameter array
The array to modify.
Parameter predicate
The function invoked per iteration. Returns the new array of removed elements.
interface LoDashStatic
interface LoDashStatic {}
method reverse
reverse: <TList extends List<any>>(array: TList) => TList;
Reverses
array
so that the first element becomes the last, the second element becomes the second to last, and so on.**Note:** This method mutates
array
and is based on [Array#reverse
](https://mdn.io/Array/reverse).Array
Returns
Returns
array
.Example 1
var array = [1, 2, 3];
_.reverse(array); // => [3, 2, 1]
console.log(array); // => [3, 2, 1]
interface LoDashStatic
interface LoDashStatic {}
method slice
slice: <T>( array: List<T> | null | undefined, start?: number, end?: number) => T[];
Creates a slice of array from start up to, but not including, end.
Parameter array
The array to slice.
Parameter start
The start position.
Parameter end
The end position. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method sortedIndex
sortedIndex: { <T>(array: List<T> | null | undefined, value: T): number; <T>(array: List<T>, value: T): number;};
Uses a binary search to determine the lowest index at which
value
should be inserted intoarray
in order to maintain its sort order.Array
Parameter array
The sorted array to inspect.
Parameter value
The value to evaluate.
Returns
Returns the index at which
value
should be inserted intoarray
.Example 1
_.sortedIndex([30, 50], 40); // => 1
_.sortedIndex([4, 5], 4); // => 0
interface LoDashStatic
interface LoDashStatic {}
method sortedIndex
sortedIndex: { <T>(array: List<T>, value: T): number; <T>(array: List<T> | null | undefined, value: T): number;};
Uses a binary search to determine the lowest index at which
value
should be inserted intoarray
in order to maintain its sort order.Array
Parameter array
The sorted array to inspect.
Parameter value
The value to evaluate.
Returns
Returns the index at which
value
should be inserted intoarray
.Example 1
_.sortedIndex([30, 50], 40); // => 1
_.sortedIndex([4, 5], 4); // => 0
interface LoDashStatic
interface LoDashStatic {}
method sortedIndexBy
sortedIndexBy: <T>( array: List<T> | null | undefined, value: T, iteratee?: ValueIteratee<T>) => number;
This method is like
_.sortedIndex
except that it acceptsiteratee
which is invoked forvalue
and each element ofarray
to compute their sort ranking. The iteratee is invoked with one argument: (value).Array
Parameter array
The sorted array to inspect.
Parameter value
The value to evaluate.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the index at which
value
should be inserted intoarray
.Example 1
var dict = { 'thirty': 30, 'forty': 40, 'fifty': 50 };
_.sortedIndexBy(['thirty', 'fifty'], 'forty', _.propertyOf(dict)); // => 1
// using the
_.property
iteratee shorthand _.sortedIndexBy([{ 'x': 4 }, { 'x': 5 }], { 'x': 4 }, 'x'); // => 0
interface LoDashStatic
interface LoDashStatic {}
method sortedIndexOf
sortedIndexOf: <T>(array: List<T> | null | undefined, value: T) => number;
This method is like
_.indexOf
except that it performs a binary search on a sortedarray
.Array
Parameter array
The array to search.
Parameter value
The value to search for.
Returns
Returns the index of the matched value, else
-1
.Example 1
_.sortedIndexOf([1, 1, 2, 2], 2); // => 2
interface LoDashStatic
interface LoDashStatic {}
method sortedLastIndex
sortedLastIndex: <T>(array: List<T> | null | undefined, value: T) => number;
This method is like
_.sortedIndex
except that it returns the highest index at whichvalue
should be inserted intoarray
in order to maintain its sort order.Array
Parameter array
The sorted array to inspect.
Parameter value
The value to evaluate.
Returns
Returns the index at which
value
should be inserted intoarray
.Example 1
_.sortedLastIndex([4, 5], 4); // => 1
interface LoDashStatic
interface LoDashStatic {}
method sortedLastIndexBy
sortedLastIndexBy: <T>( array: List<T> | null | undefined, value: T, iteratee: ValueIteratee<T>) => number;
This method is like
_.sortedLastIndex
except that it acceptsiteratee
which is invoked forvalue
and each element ofarray
to compute their sort ranking. The iteratee is invoked with one argument: (value).Array
Parameter array
The sorted array to inspect.
Parameter value
The value to evaluate.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the index at which
value
should be inserted intoarray
.Example 1
// using the
_.property
iteratee shorthand _.sortedLastIndexBy([{ 'x': 4 }, { 'x': 5 }], { 'x': 4 }, 'x'); // => 1
interface LoDashStatic
interface LoDashStatic {}
method sortedLastIndexOf
sortedLastIndexOf: <T>(array: List<T> | null | undefined, value: T) => number;
This method is like
_.lastIndexOf
except that it performs a binary search on a sortedarray
.Array
Parameter array
The array to search.
Parameter value
The value to search for.
Returns
Returns the index of the matched value, else
-1
.Example 1
_.sortedLastIndexOf([1, 1, 2, 2], 2); // => 3
interface LoDashStatic
interface LoDashStatic {}
method sortedUniq
sortedUniq: <T>(array: List<T> | null | undefined) => T[];
This method is like
_.uniq
except that it's designed and optimized for sorted arrays.Array
Parameter array
The array to inspect.
Returns
Returns the new duplicate free array.
Example 1
_.sortedUniq([1, 1, 2]); // => [1, 2]
interface LoDashStatic
interface LoDashStatic {}
method sortedUniqBy
sortedUniqBy: <T>( array: List<T> | null | undefined, iteratee: ValueIteratee<T>) => T[];
This method is like
_.uniqBy
except that it's designed and optimized for sorted arrays.Array
Parameter array
The array to inspect.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the new duplicate free array.
Example 1
_.sortedUniqBy([1.1, 1.2, 2.3, 2.4], Math.floor); // => [1.1, 2.3]
interface LoDashStatic
interface LoDashStatic {}
method tail
tail: { <T extends unknown[]>(array: readonly [unknown, ...T]): T; <T>(array: List<T>): T[];};
Gets all but the first element of array.
Parameter array
The array to query. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method take
take: <T>(array: List<T> | null | undefined, n?: number) => T[];
Creates a slice of array with n elements taken from the beginning.
Parameter array
The array to query.
Parameter n
The number of elements to take. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method takeRight
takeRight: <T>(array: List<T> | null | undefined, n?: number) => T[];
Creates a slice of array with n elements taken from the end.
Parameter array
The array to query.
Parameter n
The number of elements to take. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method takeRightWhile
takeRightWhile: <T>( array: List<T> | null | undefined, predicate?: ListIteratee<T>) => T[];
Creates a slice of array with elements taken from the end. Elements are taken until predicate returns falsey. The predicate is invoked with three arguments: (value, index, array).
Parameter array
The array to query.
Parameter predicate
The function invoked per iteration. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method takeWhile
takeWhile: <T>( array: List<T> | null | undefined, predicate?: ListIteratee<T>) => T[];
Creates a slice of array with elements taken from the beginning. Elements are taken until predicate returns falsey. The predicate is invoked with three arguments: (value, index, array).
Parameter array
The array to query.
Parameter predicate
The function invoked per iteration. Returns the slice of array.
interface LoDashStatic
interface LoDashStatic {}
method union
union: <T>(...arrays: Array<List<T> | null | undefined>) => T[];
Creates an array of unique values, in order, from all of the provided arrays using SameValueZero for equality comparisons.
Parameter arrays
The arrays to inspect. Returns the new array of combined values.
interface LoDashStatic
interface LoDashStatic {}
method unionBy
unionBy: { <T>(arrays: List<T> | null | undefined, iteratee?: ValueIteratee<T>): T[]; <T>(arrays1: List<T>, arrays2: List<T>, iteratee?: ValueIteratee<T>): T[]; <T>( arrays1: List<T>, arrays2: List<T>, arrays3: List<T>, iteratee?: ValueIteratee<T> ): T[]; <T>( arrays1: List<T>, arrays2: List<T>, arrays3: List<T>, arrays4: List<T>, iteratee?: ValueIteratee<T> ): T[]; <T>( arrays1: List<T>, arrays2: List<T>, arrays3: List<T>, arrays4: List<T>, arrays5: List<T>, ...iteratee: (ValueIteratee<T> | List<T>)[] ): T[];};
This method is like
_.union
except that it acceptsiteratee
which is invoked for each element of eacharrays
to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).Parameter arrays
The arrays to inspect.
Parameter iteratee
The iteratee invoked per element. Returns the new array of combined values.
See Also
_.unionBy
interface LoDashStatic
interface LoDashStatic {}
method unionWith
unionWith: { <T>(arrays: List<T> | null | undefined, comparator?: Comparator<T>): T[]; <T>(arrays: List<T>, arrays2: List<T>, comparator?: Comparator<T>): T[]; <T>( arrays: List<T>, arrays2: List<T>, arrays3: List<T>, ...comparator: (Comparator<T> | List<T>)[] ): T[];};
This method is like
_.union
except that it acceptscomparator
which is invoked to compare elements ofarrays
. The comparator is invoked with two arguments: (arrVal, othVal).Array
Parameter arrays
The arrays to inspect.
Parameter comparator
The comparator invoked per element.
Returns
Returns the new array of combined values.
Example 1
var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];
_.unionWith(objects, others, _.isEqual); // => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]
See Also
_.unionWith
interface LoDashStatic
interface LoDashStatic {}
method uniq
uniq: <T>(array: List<T> | null | undefined) => T[];
Creates a duplicate-free version of an array, using [
SameValueZero
](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero) for equality comparisons, in which only the first occurrence of each element is kept.Array
Parameter array
The array to inspect.
Returns
Returns the new duplicate free array.
Example 1
_.uniq([2, 1, 2]); // => [2, 1]
interface LoDashStatic
interface LoDashStatic {}
method uniqBy
uniqBy: <T>( array: List<T> | null | undefined, iteratee: ValueIteratee<T>) => T[];
This method is like
_.uniq
except that it acceptsiteratee
which is invoked for each element inarray
to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).Array
Parameter array
The array to inspect.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the new duplicate free array.
Example 1
_.uniqBy([2.1, 1.2, 2.3], Math.floor); // => [2.1, 1.2]
// using the
_.property
iteratee shorthand _.uniqBy([{ 'x': 1 }, { 'x': 2 }, { 'x': 1 }], 'x'); // => [{ 'x': 1 }, { 'x': 2 }]
interface LoDashStatic
interface LoDashStatic {}
method uniqWith
uniqWith: <T>( array: List<T> | null | undefined, comparator?: Comparator<T>) => T[];
This method is like
_.uniq
except that it acceptscomparator
which is invoked to compare elements ofarray
. The comparator is invoked with two arguments: (arrVal, othVal).Array
Parameter array
The array to inspect.
Parameter comparator
The comparator invoked per element.
Returns
Returns the new duplicate free array.
Example 1
var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 2 }];
_.uniqWith(objects, _.isEqual); // => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]
interface LoDashStatic
interface LoDashStatic {}
method unzip
unzip: <T>(array: T[][] | List<List<T>> | null | undefined) => T[][];
This method is like _.zip except that it accepts an array of grouped elements and creates an array regrouping the elements to their pre-zip configuration.
Parameter array
The array of grouped elements to process. Returns the new array of regrouped elements.
interface LoDashStatic
interface LoDashStatic {}
method unzipWith
unzipWith: { <T, TResult>( array: List<List<T>> | null | undefined, iteratee: (...values: T[]) => TResult ): TResult[]; <T>(array: List<List<T>>): T[][];};
This method is like _.unzip except that it accepts an iteratee to specify how regrouped values should be combined. The iteratee is invoked with four arguments: (accumulator, value, index, group).
Parameter array
The array of grouped elements to process.
Parameter iteratee
The function to combine regrouped values. Returns the new array of regrouped elements.
See Also
_.unzipWith
interface LoDashStatic
interface LoDashStatic {}
method without
without: <T>(array: List<T> | null | undefined, ...values: T[]) => T[];
Creates an array excluding all provided values using SameValueZero for equality comparisons.
Parameter array
The array to filter.
Parameter values
The values to exclude. Returns the new array of filtered values.
interface LoDashStatic
interface LoDashStatic {}
method xor
xor: <T>(...arrays: Array<List<T> | null | undefined>) => T[];
Creates an array of unique values that is the symmetric difference of the provided arrays.
Parameter arrays
The arrays to inspect. Returns the new array of values.
interface LoDashStatic
interface LoDashStatic {}
method xorBy
xorBy: { <T>(arrays: List<T> | null | undefined, iteratee?: ValueIteratee<T>): T[]; <T>(arrays: List<T>, arrays2: List<T>, iteratee?: ValueIteratee<T>): T[]; <T>( arrays: List<T>, arrays2: List<T>, arrays3: List<T>, ...iteratee: (ValueIteratee<T> | List<T>)[] ): T[];};
This method is like
_.xor
except that it acceptsiteratee
which is invoked for each element of eacharrays
to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).Array
Parameter arrays
The arrays to inspect.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the new array of values.
Example 1
_.xorBy([2.1, 1.2], [4.3, 2.4], Math.floor); // => [1.2, 4.3]
// using the
_.property
iteratee shorthand _.xorBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x'); // => [{ 'x': 2 }]See Also
_.xorBy
interface LoDashStatic
interface LoDashStatic {}
method xorWith
xorWith: { <T>(arrays: List<T> | null | undefined, comparator?: Comparator<T>): T[]; <T>(arrays: List<T>, arrays2: List<T>, comparator?: Comparator<T>): T[]; <T>( arrays: List<T>, arrays2: List<T>, arrays3: List<T>, ...comparator: (Comparator<T> | List<T>)[] ): T[];};
This method is like
_.xor
except that it acceptscomparator
which is invoked to compare elements ofarrays
. The comparator is invoked with two arguments: (arrVal, othVal).Array
Parameter arrays
The arrays to inspect.
Parameter comparator
The comparator invoked per element.
Returns
Returns the new array of values.
Example 1
var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];
_.xorWith(objects, others, _.isEqual); // => [{ 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]
See Also
_.xorWith
interface LoDashStatic
interface LoDashStatic {}
method zip
zip: { <T1, T2>(arrays1: List<T1>, arrays2: List<T2>): Array< [T1 | undefined, T2 | undefined] >; <T1, T2, T3>(arrays1: List<T1>, arrays2: List<T2>, arrays3: List<T3>): [ T1, T2, T3 ][]; <T1, T2, T3, T4>( arrays1: List<T1>, arrays2: List<T2>, arrays3: List<T3>, arrays4: List<T4> ): [T1, T2, T3, T4][]; <T1, T2, T3, T4, T5>( arrays1: List<T1>, arrays2: List<T2>, arrays3: List<T3>, arrays4: List<T4>, arrays5: List<T5> ): [T1, T2, T3, T4, T5][]; <T>(...arrays: List<T>[]): T[][];};
Creates an array of grouped elements, the first of which contains the first elements of the given arrays, the second of which contains the second elements of the given arrays, and so on.
Parameter arrays
The arrays to process. Returns the new array of grouped elements.
See Also
_.zip
interface LoDashStatic
interface LoDashStatic {}
method zipObject
zipObject: { <T>(props: List<PropertyName>, values: List<T>): Dictionary<T>; (props?: List<PropertyName>): Dictionary<undefined>;};
This method is like _.fromPairs except that it accepts two arrays, one of property identifiers and one of corresponding values.
Parameter props
The property names.
Parameter values
The property values. Returns the new object.
See Also
_.zipObject
interface LoDashStatic
interface LoDashStatic {}
method zipObjectDeep
zipObjectDeep: (paths?: List<PropertyPath>, values?: List<any>) => object;
This method is like _.zipObject except that it supports property paths.
Parameter paths
The property names.
Parameter values
The property values. Returns the new object.
interface LoDashStatic
interface LoDashStatic {}
method zipWith
zipWith: { <T, TResult>(arrays: List<T>, iteratee: (value1: T) => TResult): TResult[]; <T1, T2, TResult>( arrays1: List<T1>, arrays2: List<T2>, iteratee: (value1: T1, value2: T2) => TResult ): TResult[]; <T1, T2, T3, TResult>( arrays1: List<T1>, arrays2: List<T2>, arrays3: List<T3>, iteratee: (value1: T1, value2: T2, value3: T3) => TResult ): TResult[]; <T1, T2, T3, T4, TResult>( arrays1: List<T1>, arrays2: List<T2>, arrays3: List<T3>, arrays4: List<T4>, iteratee: (value1: T1, value2: T2, value3: T3, value4: T4) => TResult ): TResult[]; <T1, T2, T3, T4, T5, TResult>( arrays1: List<T1>, arrays2: List<T2>, arrays3: List<T3>, arrays4: List<T4>, arrays5: List<T5>, iteratee: ( value1: T1, value2: T2, value3: T3, value4: T4, value5: T5 ) => TResult ): TResult[]; <T, TResult>( ...iteratee: (((...group: T[]) => TResult) | List<T>)[] ): TResult[];};
This method is like _.zip except that it accepts an iteratee to specify how grouped values should be combined. The iteratee is invoked with four arguments: (accumulator, value, index, group).
Parameter arrays
The arrays to process.
Parameter iteratee
The function to combine grouped values. Returns the new array of grouped elements.
See Also
_.zipWith
interface LoDashStatic
interface LoDashStatic {}
method countBy
countBy: { <T>( collection: List<T> | null | undefined, iteratee?: ValueIteratee<T> ): Dictionary<number>; <T extends object>( collection: T, iteratee?: ValueIteratee<T[keyof T]> ): Dictionary<number>;};
Creates an object composed of keys generated from the results of running each element of collection through iteratee. The corresponding value of each key is the number of times the key was returned by iteratee. The iteratee is invoked with one argument: (value).
Parameter collection
The collection to iterate over.
Parameter iteratee
The function invoked per iteration. Returns the composed aggregate object.
See Also
_.countBy
interface LoDashStatic
interface LoDashStatic {}
property each
each: LoDashStatic['forEach'];
See Also
_.forEach
interface LoDashStatic
interface LoDashStatic {}
property eachRight
eachRight: LoDashStatic['forEachRight'];
See Also
_.forEachRight
interface LoDashStatic
interface LoDashStatic {}
method every
every: { <T>( collection: List<T> | null | undefined, predicate?: ListIterateeCustom<T, boolean> ): boolean; <T extends object>( collection: T, predicate?: ObjectIterateeCustom<T, boolean> ): boolean;};
Checks if predicate returns truthy for all elements of collection. Iteration is stopped once predicate returns falsey. The predicate is invoked with three arguments: (value, index|key, collection).
Parameter collection
The collection to iterate over.
Parameter predicate
The function invoked per iteration. Returns true if all elements pass the predicate check, else false.
See Also
_.every
interface LoDashStatic
interface LoDashStatic {}
method filter
filter: { ( collection: string | null | undefined, predicate?: StringIterator<boolean> ): string[]; <T, S extends T>( collection: List<T>, predicate: ListIteratorTypeGuard<T, S> ): S[]; <T>(collection: List<T>, predicate?: ListIterateeCustom<T, boolean>): T[]; <T extends object, S extends T[keyof T]>( collection: T, predicate: ObjectIteratorTypeGuard<T, S> ): S[]; <T extends object>( collection: T, predicate?: ObjectIterateeCustom<T, boolean> ): T[keyof T][];};
Iterates over elements of collection, returning an array of all elements predicate returns truthy for. The predicate is invoked with three arguments: (value, index|key, collection).
Parameter collection
The collection to iterate over.
Parameter predicate
The function invoked per iteration. Returns the new filtered array.
See Also
_.filter
interface LoDashStatic
interface LoDashStatic {}
method find
find: { <T, S extends T>( collection: List<T> | null | undefined, predicate: ListIteratorTypeGuard<T, S>, fromIndex?: number ): S | undefined; <T>( collection: List<T>, predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number ): T; <T extends object, S extends T[keyof T]>( collection: T, predicate: ObjectIteratorTypeGuard<T, S>, fromIndex?: number ): S; <T extends object>( collection: T, predicate?: ObjectIterateeCustom<T, boolean>, fromIndex?: number ): T[keyof T];};
Iterates over elements of collection, returning the first element predicate returns truthy for. The predicate is invoked with three arguments: (value, index|key, collection).
Parameter collection
The collection to search.
Parameter predicate
The function invoked per iteration.
Parameter fromIndex
The index to search from. Returns the matched element, else undefined.
See Also
_.find
interface LoDashStatic
interface LoDashStatic {}
method findLast
findLast: { <T, S extends T>( collection: List<T> | null | undefined, predicate: ListIteratorTypeGuard<T, S>, fromIndex?: number ): S | undefined; <T>( collection: List<T>, predicate?: ListIterateeCustom<T, boolean>, fromIndex?: number ): T; <T extends object, S extends T[keyof T]>( collection: T, predicate: ObjectIteratorTypeGuard<T, S>, fromIndex?: number ): S; <T extends object>( collection: T, predicate?: ObjectIterateeCustom<T, boolean>, fromIndex?: number ): T[keyof T];};
This method is like _.find except that it iterates over elements of a collection from right to left.
Parameter collection
Searches for a value in this list.
Parameter predicate
The function called per iteration.
Parameter fromIndex
The index to search from. The found element, else undefined.
See Also
_.findLast
interface LoDashStatic
interface LoDashStatic {}
method flatMap
flatMap: { <T>( collection: | Dictionary<Many<T>> | NumericDictionary<Many<T>> | null | undefined ): T[]; (collection: object): any[]; <T, TResult>( collection: List<T>, iteratee: ListIterator<T, Many<TResult>> ): TResult[]; <T extends object, TResult>( collection: T, iteratee: ObjectIterator<T, Many<TResult>> ): TResult[]; (collection: object, iteratee: string): any[]; (collection: object, iteratee: object): boolean[];};
Creates an array of flattened values by running each element in collection through iteratee and concating its result to the other mapped values. The iteratee is invoked with three arguments: (value, index|key, collection).
Parameter collection
The collection to iterate over.
Parameter iteratee
The function invoked per iteration. Returns the new flattened array.
See Also
_.flatMap
interface LoDashStatic
interface LoDashStatic {}
method flatMapDeep
flatMapDeep: { <T>( collection: | Dictionary<ListOfRecursiveArraysOrValues<T> | T> | NumericDictionary<ListOfRecursiveArraysOrValues<T> | T> | null | undefined ): T[]; <T, TResult>( collection: List<T>, iteratee: ListIterator< T, TResult | ListOfRecursiveArraysOrValues<TResult> > ): TResult[]; <T extends object, TResult>( collection: T, iteratee: ObjectIterator< T, TResult | ListOfRecursiveArraysOrValues<TResult> > ): TResult[]; (collection: object, iteratee: string): any[]; (collection: object, iteratee: object): boolean[];};
This method is like
_.flatMap
except that it recursively flattens the mapped results.4.7.0 Collection
Parameter collection
The collection to iterate over.
Parameter iteratee
The function invoked per iteration.
Returns
Returns the new flattened array.
Example 1
function duplicate(n) { return [[[n, n]]]; }
_.flatMapDeep([1, 2], duplicate); // => [1, 1, 2, 2]
See Also
_.flatMapDeep
interface LoDashStatic
interface LoDashStatic {}
method flatMapDepth
flatMapDepth: { <T>( collection: | Dictionary<ListOfRecursiveArraysOrValues<T> | T> | NumericDictionary<ListOfRecursiveArraysOrValues<T> | T> | null | undefined ): T[]; <T, TResult>( collection: List<T>, iteratee: ListIterator< T, TResult | ListOfRecursiveArraysOrValues<TResult> >, depth?: number ): TResult[]; <T extends object, TResult>( collection: T, iteratee: ObjectIterator< T, TResult | ListOfRecursiveArraysOrValues<TResult> >, depth?: number ): TResult[]; (collection: object, iteratee: string, depth?: number): any[]; (collection: object, iteratee: object, depth?: number): boolean[];};
This method is like
_.flatMap
except that it recursively flattens the mapped results up todepth
times.4.7.0 Collection
Parameter collection
The collection to iterate over.
Parameter iteratee
The function invoked per iteration.
Parameter depth
The maximum recursion depth.
Returns
Returns the new flattened array.
Example 1
function duplicate(n) { return [[[n, n]]]; }
_.flatMapDepth([1, 2], duplicate, 2); // => [[1, 1], [2, 2]]
See Also
_.flatMapDepth
interface LoDashStatic
interface LoDashStatic {}
method forEach
forEach: { <T>(collection: T[], iteratee?: ArrayIterator<T, any>): T[]; (collection: string, iteratee?: StringIterator<any>): string; <T>(collection: List<T>, iteratee?: ListIterator<T, any>): List<T>; <T extends object>(collection: T, iteratee?: ObjectIterator<T, any>): T; <T, TArray extends T[]>( collection: TArray & T[], iteratee?: ArrayIterator<T, any> ): TArray; <TString extends string>( collection: TString, iteratee?: StringIterator<any> ): TString; <T, TList extends List<T>>( collection: TList & List<T>, iteratee?: ListIterator<T, any> ): TList; <T extends object>(collection: T, iteratee?: ObjectIterator<T, any>): T;};
Iterates over elements of collection invoking iteratee for each element. The iteratee is invoked with three arguments: (value, index|key, collection). Iteratee functions may exit iteration early by explicitly returning false.
Note: As with other "Collections" methods, objects with a "length" property are iterated like arrays. To avoid this behavior _.forIn or _.forOwn may be used for object iteration.
_.each
Parameter collection
The collection to iterate over.
Parameter iteratee
The function invoked per iteration.
See Also
_.forEach
interface LoDashStatic
interface LoDashStatic {}
method forEachRight
forEachRight: { <T>(collection: T[], iteratee?: ArrayIterator<T, any>): T[]; (collection: string, iteratee?: StringIterator<any>): string; <T>(collection: List<T>, iteratee?: ListIterator<T, any>): List<T>; <T extends object>(collection: T, iteratee?: ObjectIterator<T, any>): T; <T, TArray extends T[]>( collection: TArray & T[], iteratee?: ArrayIterator<T, any> ): TArray; <TString extends string>( collection: TString, iteratee?: StringIterator<any> ): TString; <T, TList extends List<T>>( collection: TList & List<T>, iteratee?: ListIterator<T, any> ): TList; <T extends object>(collection: T, iteratee?: ObjectIterator<T, any>): T;};
This method is like _.forEach except that it iterates over elements of collection from right to left.
_.eachRight
Parameter collection
The collection to iterate over.
Parameter iteratee
The function called per iteration.
See Also
_.forEachRight
interface LoDashStatic
interface LoDashStatic {}
method groupBy
groupBy: { <T>( collection: List<T> | null | undefined, iteratee?: ValueIteratee<T> ): Dictionary<T[]>; <T extends object>( collection: T, iteratee?: ValueIteratee<T[keyof T]> ): Dictionary<T[keyof T][]>;};
Creates an object composed of keys generated from the results of running each element of collection through iteratee. The corresponding value of each key is an array of the elements responsible for generating the key. The iteratee is invoked with one argument: (value).
Parameter collection
The collection to iterate over.
Parameter iteratee
The function invoked per iteration. Returns the composed aggregate object.
See Also
_.groupBy
interface LoDashStatic
interface LoDashStatic {}
method includes
includes: <T>( collection: Dictionary<T> | NumericDictionary<T> | null | undefined, target: T, fromIndex?: number) => boolean;
Checks if target is in collection using SameValueZero for equality comparisons. If fromIndex is negative, it’s used as the offset from the end of collection.
Parameter collection
The collection to search.
Parameter target
The value to search for.
Parameter fromIndex
The index to search from. True if the target element is found, else false.
interface LoDashStatic
interface LoDashStatic {}
method invokeMap
invokeMap: { ( collection: object | null | undefined, methodName: string, ...args: any[] ): any[]; <TResult>( collection: object, method: (...args: any[]) => TResult, ...args: any[] ): TResult[];};
Invokes the method named by methodName on each element in the collection returning an array of the results of each invoked method. Additional arguments will be provided to each invoked method. If methodName is a function it will be invoked for, and this bound to, each element in the collection.
Parameter collection
The collection to iterate over.
Parameter methodName
The name of the method to invoke.
Parameter args
Arguments to invoke the method with.
See Also
_.invokeMap
interface LoDashStatic
interface LoDashStatic {}
method keyBy
keyBy: { <T>( collection: List<T> | null | undefined, iteratee?: ValueIterateeCustom<T, PropertyName> ): Dictionary<T>; <T extends object>( collection: T, iteratee?: ValueIterateeCustom<T[keyof T], PropertyName> ): Dictionary<T[keyof T]>;};
Creates an object composed of keys generated from the results of running each element of collection through iteratee. The corresponding value of each key is the last element responsible for generating the key. The iteratee function is invoked with one argument: (value).
Parameter collection
The collection to iterate over.
Parameter iteratee
The function invoked per iteration. Returns the composed aggregate object.
See Also
_.keyBy
interface LoDashStatic
interface LoDashStatic {}
method map
map: { <T extends readonly [unknown, ...unknown[]], TResult>( collection: T, iteratee: TupleIterator<T, TResult> ): { [K in keyof T]: TResult }; <T, TResult>( collection: T[], iteratee: ArrayIterator<T, TResult> ): TResult[]; <T, TResult>( collection: List<T>, iteratee: ListIterator<T, TResult> ): TResult[]; <T>(collection: Dictionary<T> | NumericDictionary<T>): T[]; <T extends object, TResult>( collection: T, iteratee: ObjectIterator<T, TResult> ): TResult[]; <T, K extends keyof T>( collection: Dictionary<T> | NumericDictionary<T>, iteratee: K ): T[K][]; <T>( collection: Dictionary<T> | NumericDictionary<T>, iteratee?: string ): any[]; <T>( collection: Dictionary<T> | NumericDictionary<T>, iteratee?: object ): boolean[];};
Creates an array of values by running each element in collection through iteratee. The iteratee is invoked with three arguments: (value, index|key, collection).
Many lodash methods are guarded to work as iteratees for methods like _.every, _.filter, _.map, _.mapValues, _.reject, and _.some.
The guarded methods are: ary, callback, chunk, clone, create, curry, curryRight, drop, dropRight, every, fill, flatten, invert, max, min, parseInt, slice, sortBy, take, takeRight, template, trim, trimLeft, trimRight, trunc, random, range, sample, some, sum, uniq, and words
Parameter collection
The collection to iterate over.
Parameter iteratee
The function invoked per iteration. Returns the new mapped array.
See Also
_.map
interface LoDashStatic
interface LoDashStatic {}
method orderBy
orderBy: { <T>( collection: List<T> | null | undefined, iteratees?: Many<ListIterator<T, NotVoid>>, orders?: Many<boolean | 'asc' | 'desc'> ): T[]; <T>( collection: List<T>, iteratees?: Many<ListIteratee<T>>, orders?: Many<boolean | 'asc' | 'desc'> ): T[]; <T extends object>( collection: T, iteratees?: Many<ObjectIterator<T, unknown>>, orders?: Many<boolean | 'asc' | 'desc'> ): T[keyof T][]; <T extends object>( collection: T, iteratees?: Many<ObjectIteratee<T>>, orders?: Many<boolean | 'asc' | 'desc'> ): T[keyof T][];};
This method is like
_.sortBy
except that it allows specifying the sort orders of the iteratees to sort by. Iforders
is unspecified, all values are sorted in ascending order. Otherwise, specify an order of "desc" for descending or "asc" for ascending sort order of corresponding values.Collection
Parameter collection
The collection to iterate over.
Parameter iteratees
The iteratees to sort by.
Parameter orders
The sort orders of
iteratees
.Parameter guard
Enables use as an iteratee for functions like
_.reduce
.Returns
Returns the new sorted array.
Example 1
var users = [ { 'user': 'fred', 'age': 48 }, { 'user': 'barney', 'age': 34 }, { 'user': 'fred', 'age': 42 }, { 'user': 'barney', 'age': 36 } ];
// sort by
user
in ascending order and byage
in descending order _.orderBy(users, ['user', 'age'], ['asc', 'desc']); // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]See Also
_.orderBy
interface LoDashStatic
interface LoDashStatic {}
method partition
partition: { <T, U extends T>( collection: List<T> | null | undefined, callback: ValueIteratorTypeGuard<T, U> ): [U[], Array<Exclude<T, U>>]; <T>(collection: List<T>, callback: ValueIteratee<T>): [T[], T[]]; <T extends object>(collection: T, callback: ValueIteratee<T[keyof T]>): [ T[keyof T][], T[keyof T][] ];};
Creates an array of elements split into two groups, the first of which contains elements predicate returns truthy for, while the second of which contains elements predicate returns falsey for. The predicate is invoked with three arguments: (value, index|key, collection).
Parameter collection
The collection to iterate over.
Parameter callback
The function called per iteration. Returns the array of grouped elements.
See Also
_.partition
interface LoDashStatic
interface LoDashStatic {}
method reduce
reduce: { <T, TResult>( collection: T[] | null | undefined, callback: MemoListIterator<T, TResult, T[]>, accumulator: TResult ): TResult; <T, TResult>( collection: List<T>, callback: MemoListIterator<T, TResult, List<T>>, accumulator: TResult ): TResult; <T extends object, TResult>( collection: T, callback: MemoObjectIterator<T[keyof T], TResult, T>, accumulator: TResult ): TResult; <T>(collection: T[], callback: MemoListIterator<T, T, T[]>): T; <T>(collection: List<T>, callback: MemoListIterator<T, T, List<T>>): T; <T extends object>( collection: T, callback: MemoObjectIterator<T[keyof T], T[keyof T], T> ): T[keyof T];};
Reduces a collection to a value which is the accumulated result of running each element in the collection through the callback, where each successive callback execution consumes the return value of the previous execution. If accumulator is not provided the first element of the collection will be used as the initial accumulator value. The callback is invoked with four arguments: (accumulator, value, index|key, collection).
Parameter collection
The collection to iterate over.
Parameter callback
The function called per iteration.
Parameter accumulator
Initial value of the accumulator. Returns the accumulated value.
See Also
_.reduce
interface LoDashStatic
interface LoDashStatic {}
method reduceRight
reduceRight: { <T, TResult>( collection: T[] | null | undefined, callback: MemoListIterator<T, TResult, T[]>, accumulator: TResult ): TResult; <T, TResult>( collection: List<T>, callback: MemoListIterator<T, TResult, List<T>>, accumulator: TResult ): TResult; <T extends object, TResult>( collection: T, callback: MemoObjectIterator<T[keyof T], TResult, T>, accumulator: TResult ): TResult; <T>(collection: T[], callback: MemoListIterator<T, T, T[]>): T; <T>(collection: List<T>, callback: MemoListIterator<T, T, List<T>>): T; <T extends object>( collection: T, callback: MemoObjectIterator<T[keyof T], T[keyof T], T> ): T[keyof T];};
This method is like _.reduce except that it iterates over elements of a collection from right to left.
Parameter collection
The collection to iterate over.
Parameter callback
The function called per iteration.
Parameter accumulator
Initial value of the accumulator. The accumulated value.
See Also
_.reduceRight
interface LoDashStatic
interface LoDashStatic {}
method reject
reject: { ( collection: string | null | undefined, predicate?: StringIterator<boolean> ): string[]; <T>(collection: List<T>, predicate?: ListIterateeCustom<T, boolean>): T[]; <T extends object>( collection: T, predicate?: ObjectIterateeCustom<T, boolean> ): T[keyof T][];};
The opposite of _.filter; this method returns the elements of collection that predicate does not return truthy for.
Parameter collection
The collection to iterate over.
Parameter predicate
The function invoked per iteration. Returns the new filtered array.
See Also
_.reject
interface LoDashStatic
interface LoDashStatic {}
method sample
sample: { <T>(collection: readonly [T, ...T[]]): T; <T>(collection: Dictionary<T> | NumericDictionary<T>): T; <T extends object>(collection: T): T[keyof T];};
Gets a random element from collection.
Parameter collection
The collection to sample. Returns the random element.
See Also
_.sample
interface LoDashStatic
interface LoDashStatic {}
method sampleSize
sampleSize: { <T>( collection: Dictionary<T> | NumericDictionary<T> | null | undefined, n?: number ): T[]; <T extends object>(collection: T, n?: number): T[keyof T][];};
Gets n random elements at unique keys from collection up to the size of collection.
Parameter collection
The collection to sample.
Parameter n
The number of elements to sample. Returns the random elements.
See Also
_.sampleSize
interface LoDashStatic
interface LoDashStatic {}
method shuffle
shuffle: { <T>(collection: List<T> | null | undefined): T[]; <T extends object>(collection: T): T[keyof T][];};
Creates an array of shuffled values, using a version of the Fisher-Yates shuffle.
Parameter collection
The collection to shuffle. Returns the new shuffled array.
See Also
_.shuffle
interface LoDashStatic
interface LoDashStatic {}
method size
size: (collection: object | string | null | undefined) => number;
Gets the size of collection by returning its length for array-like values or the number of own enumerable properties for objects.
Parameter collection
The collection to inspect. Returns the size of collection.
interface LoDashStatic
interface LoDashStatic {}
method some
some: { <T>( collection: List<T> | null | undefined, predicate?: ListIterateeCustom<T, boolean> ): boolean; <T extends object>( collection: T, predicate?: ObjectIterateeCustom<T, boolean> ): boolean;};
Checks if predicate returns truthy for any element of collection. Iteration is stopped once predicate returns truthy. The predicate is invoked with three arguments: (value, index|key, collection).
Parameter collection
The collection to iterate over.
Parameter predicate
The function invoked per iteration. Returns true if any element passes the predicate check, else false.
See Also
_.some
interface LoDashStatic
interface LoDashStatic {}
method sortBy
sortBy: { <T>( collection: List<T> | null | undefined, ...iteratees: Array<Many<ListIteratee<T>>> ): T[]; <T extends object>( collection: T, ...iteratees: Many<ObjectIteratee<T>>[] ): T[keyof T][];};
Creates an array of elements, sorted in ascending order by the results of running each element in a collection through each iteratee. This method performs a stable sort, that is, it preserves the original sort order of equal elements. The iteratees are invoked with one argument: (value).
Collection
Parameter collection
The collection to iterate over.
Parameter iteratees
The iteratees to sort by, specified individually or in arrays.
Returns
Returns the new sorted array.
Example 1
var users = [ { 'user': 'fred', 'age': 48 }, { 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 42 }, { 'user': 'barney', 'age': 34 } ];
_.sortBy(users, function(o) { return o.user; }); // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]
_.sortBy(users, ['user', 'age']); // => objects for [['barney', 34], ['barney', 36], ['fred', 42], ['fred', 48]]
_.sortBy(users, 'user', function(o) { return Math.floor(o.age / 10); }); // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]
See Also
_.sortBy
interface LoDashStatic
interface LoDashStatic {}
method now
now: () => number;
interface LoDashStatic
interface LoDashStatic {}
method after
after: <TFunc extends (...args: any[]) => any>(n: number, func: TFunc) => TFunc;
The opposite of _.before; this method creates a function that invokes func once it’s called n or more times.
Parameter n
The number of calls before func is invoked.
Parameter func
The function to restrict. Returns the new restricted function.
interface LoDashStatic
interface LoDashStatic {}
method ary
ary: (func: (...args: any[]) => any, n?: number) => (...args: any[]) => any;
Creates a function that accepts up to n arguments ignoring any additional arguments.
Parameter func
The function to cap arguments for.
Parameter n
The arity cap.
Returns
Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method before
before: <TFunc extends (...args: any[]) => any>(n: number, func: TFunc) => TFunc;
Creates a function that invokes func, with the this binding and arguments of the created function, while it’s called less than n times. Subsequent calls to the created function return the result of the last func invocation.
Parameter n
The number of calls at which func is no longer invoked.
Parameter func
The function to restrict. Returns the new restricted function.
interface LoDashStatic
interface LoDashStatic {}
property bind
bind: FunctionBind;
Creates a function that invokes func with the this binding of thisArg and prepends any additional _.bind arguments to those provided to the bound function.
The _.bind.placeholder value, which defaults to _ in monolithic builds, may be used as a placeholder for partially applied arguments.
Note: Unlike native Function#bind this method does not set the "length" property of bound functions.
Parameter func
The function to bind.
Parameter thisArg
The this binding of func.
Parameter partials
The arguments to be partially applied. Returns the new bound function.
interface LoDashStatic
interface LoDashStatic {}
property bindKey
bindKey: FunctionBindKey;
Creates a function that invokes the method at object[key] and prepends any additional _.bindKey arguments to those provided to the bound function.
This method differs from _.bind by allowing bound functions to reference methods that may be redefined or don’t yet exist. See Peter Michaux’s article for more details.
The _.bindKey.placeholder value, which defaults to _ in monolithic builds, may be used as a placeholder for partially applied arguments.
Parameter object
The object the method belongs to.
Parameter key
The key of the method.
Parameter partials
The arguments to be partially applied. Returns the new bound function.
interface LoDashStatic
interface LoDashStatic {}
property curry
curry: Curry;
interface LoDashStatic
interface LoDashStatic {}
property curryRight
curryRight: CurryRight;
interface LoDashStatic
interface LoDashStatic {}
method debounce
debounce: { <T extends (...args: any) => any>( func: T, wait: number | undefined, options: DebounceSettingsLeading ): DebouncedFuncLeading<T>; <T extends (...args: any) => any>( func: T, wait?: number, options?: DebounceSettings ): DebouncedFunc<T>;};
Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a cancel method to cancel delayed invocations and a flush method to immediately invoke them. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the debounced function return the result of the last func invocation.
Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the the debounced function is invoked more than once during the wait timeout.
See David Corbacho’s article for details over the differences between _.debounce and _.throttle.
Parameter func
The function to debounce.
Parameter wait
The number of milliseconds to delay.
Parameter options
The options object.
Parameter
options.leading Specify invoking on the leading edge of the timeout.
Parameter
options.maxWait The maximum time func is allowed to be delayed before it’s invoked.
Parameter
options.trailing Specify invoking on the trailing edge of the timeout. Returns the new debounced function.
interface LoDashStatic
interface LoDashStatic {}
method defer
defer: (func: (...args: any[]) => any, ...args: any[]) => number;
Defers invoking the func until the current call stack has cleared. Any additional arguments are provided to func when it’s invoked.
Parameter func
The function to defer.
Parameter args
The arguments to invoke the function with. Returns the timer id.
interface LoDashStatic
interface LoDashStatic {}
method delay
delay: (func: (...args: any[]) => any, wait: number, ...args: any[]) => number;
Invokes func after wait milliseconds. Any additional arguments are provided to func when it’s invoked.
Parameter func
The function to delay.
Parameter wait
The number of milliseconds to delay invocation.
Parameter args
The arguments to invoke the function with. Returns the timer id.
interface LoDashStatic
interface LoDashStatic {}
method flip
flip: <T extends (...args: any) => any>(func: T) => T;
Creates a function that invokes
func
with arguments reversed.Function
Parameter func
The function to flip arguments for.
Returns
Returns the new function.
Example 1
var flipped = _.flip(function() { return _.toArray(arguments); });
flipped('a', 'b', 'c', 'd'); // => ['d', 'c', 'b', 'a']
interface LoDashStatic
interface LoDashStatic {}
property memoize
memoize: { <T extends (...args: any) => any>( func: T, resolver?: (...args: Parameters<T>) => any ): T & MemoizedFunction; Cache: MapCacheConstructor;};
Creates a function that memoizes the result of func. If resolver is provided it determines the cache key for storing the result based on the arguments provided to the memoized function. By default, the first argument provided to the memoized function is coerced to a string and used as the cache key. The func is invoked with the this binding of the memoized function.
Parameter func
The function to have its output memoized.
Parameter resolver
The function to resolve the cache key. Returns the new memoizing function.
interface LoDashStatic
interface LoDashStatic {}
method negate
negate: <T extends any[]>( predicate: (...args: T) => boolean) => (...args: T) => boolean;
Creates a function that negates the result of the predicate func. The func predicate is invoked with the this binding and arguments of the created function.
Parameter predicate
The predicate to negate. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method once
once: <T extends (...args: any) => any>(func: T) => T;
Creates a function that is restricted to invoking func once. Repeat calls to the function return the value of the first call. The func is invoked with the this binding and arguments of the created function.
Parameter func
The function to restrict. Returns the new restricted function.
interface LoDashStatic
interface LoDashStatic {}
method overArgs
overArgs: ( func: (...args: any[]) => any, ...transforms: Many<(...args: any[]) => any>[]) => (...args: any[]) => any;
Creates a function that runs each argument through a corresponding transform function.
Parameter func
The function to wrap.
Parameter transforms
The functions to transform arguments, specified as individual functions or arrays of functions. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
property partial
partial: Partial;
Creates a function that, when called, invokes func with any additional partial arguments prepended to those provided to the new function. This method is similar to _.bind except it does not alter the this binding.
Parameter func
The function to partially apply arguments to.
Parameter args
Arguments to be partially applied. The new partially applied function.
interface LoDashStatic
interface LoDashStatic {}
property partialRight
partialRight: PartialRight;
This method is like _.partial except that partial arguments are appended to those provided to the new function.
Parameter func
The function to partially apply arguments to.
Parameter args
Arguments to be partially applied. The new partially applied function.
interface LoDashStatic
interface LoDashStatic {}
method rearg
rearg: ( func: (...args: any[]) => any, ...indexes: Array<Many<number>>) => (...args: any[]) => any;
Creates a function that invokes func with arguments arranged according to the specified indexes where the argument value at the first index is provided as the first argument, the argument value at the second index is provided as the second argument, and so on.
Parameter func
The function to rearrange arguments for.
Parameter indexes
The arranged argument indexes, specified as individual indexes or arrays of indexes. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method rest
rest: (func: (...args: any[]) => any, start?: number) => (...args: any[]) => any;
Creates a function that invokes func with the this binding of the created function and arguments from start and beyond provided as an array.
Note: This method is based on the rest parameter.
Parameter func
The function to apply a rest parameter to.
Parameter start
The start position of the rest parameter. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method spread
spread: <TResult>( func: (...args: any[]) => TResult, start?: number) => (...args: any[]) => TResult;
Creates a function that invokes func with the this binding of the created function and an array of arguments much like Function#apply.
Note: This method is based on the spread operator.
Parameter func
The function to spread arguments over. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method throttle
throttle: { <T extends (...args: any) => any>( func: T, wait?: number, options?: ThrottleSettingsLeading ): DebouncedFuncLeading<T>; <T extends (...args: any) => any>( func: T, wait?: number, options?: ThrottleSettings ): DebouncedFunc<T>;};
Creates a throttled function that only invokes func at most once per every wait milliseconds. The throttled function comes with a cancel method to cancel delayed invocations and a flush method to immediately invoke them. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the throttled function return the result of the last func call.
Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the the throttled function is invoked more than once during the wait timeout.
Parameter func
The function to throttle.
Parameter wait
The number of milliseconds to throttle invocations to.
Parameter options
The options object.
Parameter
options.leading Specify invoking on the leading edge of the timeout.
Parameter
options.trailing Specify invoking on the trailing edge of the timeout. Returns the new throttled function.
interface LoDashStatic
interface LoDashStatic {}
method unary
unary: <T, TResult>( func: (arg1: T, ...args: any[]) => TResult) => (arg1: T) => TResult;
Creates a function that accepts up to one argument, ignoring any additional arguments.
Function
Parameter func
The function to cap arguments for.
Returns
Returns the new function.
Example 1
_.map(['6', '8', '10'], _.unary(parseInt)); // => [6, 8, 10]
interface LoDashStatic
interface LoDashStatic {}
method wrap
wrap: <T, TArgs, TResult>( value: T, wrapper: (value: T, ...args: TArgs[]) => TResult) => (...args: TArgs[]) => TResult;
Creates a function that provides value to the wrapper function as its first argument. Any additional arguments provided to the function are appended to those provided to the wrapper function. The wrapper is invoked with the this binding of the created function.
Parameter value
The value to wrap.
Parameter wrapper
The wrapper function. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method castArray
castArray: <T>(value?: Many<T>) => T[];
Casts value as an array if it’s not one.
Parameter value
The value to inspect. Returns the cast array.
interface LoDashStatic
interface LoDashStatic {}
method clone
clone: <T>(value: T) => T;
Creates a shallow clone of value.
Note: This method is loosely based on the structured clone algorithm and supports cloning arrays, array buffers, booleans, date objects, maps, numbers, Object objects, regexes, sets, strings, symbols, and typed arrays. The own enumerable properties of arguments objects are cloned as plain objects. An empty object is returned for uncloneable values such as error objects, functions, DOM nodes, and WeakMaps.
Parameter value
The value to clone. Returns the cloned value.
interface LoDashStatic
interface LoDashStatic {}
method cloneDeep
cloneDeep: <T>(value: T) => T;
This method is like _.clone except that it recursively clones value.
Parameter value
The value to recursively clone. Returns the deep cloned value.
interface LoDashStatic
interface LoDashStatic {}
method cloneDeepWith
cloneDeepWith: { <T>(value: T, customizer: CloneDeepWithCustomizer<T>): any; <T>(value: T): T;};
This method is like _.cloneWith except that it recursively clones value.
Parameter value
The value to recursively clone.
Parameter customizer
The function to customize cloning. Returns the deep cloned value.
See Also
_.cloneDeepWith
interface LoDashStatic
interface LoDashStatic {}
method cloneWith
cloneWith: { <T, TResult extends string | number | boolean | object>( value: T, customizer: CloneWithCustomizer<T, TResult> ): TResult; <T, TResult>(value: T, customizer: CloneWithCustomizer<T, TResult>): | T | TResult; <T>(value: T): T;};
This method is like _.clone except that it accepts customizer which is invoked to produce the cloned value. If customizer returns undefined cloning is handled by the method instead.
Parameter value
The value to clone.
Parameter customizer
The function to customize cloning. Returns the cloned value.
See Also
_.cloneWith
interface LoDashStatic
interface LoDashStatic {}
method conformsTo
conformsTo: <T>(object: T, source: ConformsPredicateObject<T>) => boolean;
Checks if object conforms to source by invoking the predicate properties of source with the corresponding property values of object.
Note: This method is equivalent to _.conforms when source is partially applied.
interface LoDashStatic
interface LoDashStatic {}
method eq
eq: (value: any, other: any) => boolean;
Performs a [
SameValueZero
](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero) comparison between two values to determine if they are equivalent.Lang
Parameter value
The value to compare.
Parameter other
The other value to compare.
Returns
Returns
true
if the values are equivalent, elsefalse
.Example 1
var object = { 'user': 'fred' }; var other = { 'user': 'fred' };
_.eq(object, object); // => true
_.eq(object, other); // => false
_.eq('a', 'a'); // => true
_.eq('a', Object('a')); // => false
_.eq(NaN, NaN); // => true
interface LoDashStatic
interface LoDashStatic {}
method gt
gt: (value: any, other: any) => boolean;
Checks if value is greater than other.
Parameter value
The value to compare.
Parameter other
The other value to compare. Returns true if value is greater than other, else false.
interface LoDashStatic
interface LoDashStatic {}
method gte
gte: (value: any, other: any) => boolean;
Checks if value is greater than or equal to other.
Parameter value
The value to compare.
Parameter other
The other value to compare. Returns true if value is greater than or equal to other, else false.
interface LoDashStatic
interface LoDashStatic {}
method isArguments
isArguments: (value?: any) => value is IArguments;
Checks if value is classified as an arguments object.
Parameter value
The value to check. Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isArray
isArray: { (value?: any): value is any[]; <T>(value?: any): value is any[] };
Checks if value is classified as an Array object.
Parameter value
The value to check.
Returns true if value is correctly classified, else false.
See Also
_.isArray
interface LoDashStatic
interface LoDashStatic {}
method isArrayBuffer
isArrayBuffer: (value?: any) => value is ArrayBuffer;
Checks if value is classified as an ArrayBuffer object.
Parameter value
The value to check. Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isArrayLike
isArrayLike: { <T extends { __lodashAnyHack: any }>(t: T): boolean; (value: (...args: any[]) => any): value is never; (value: any): value is { length: number };};
Checks if
value
is array-like. A value is considered array-like if it's not a function and has avalue.length
that's an integer greater than or equal to0
and less than or equal toNumber.MAX_SAFE_INTEGER
.Lang
Parameter value
The value to check.
Returns
Returns
true
ifvalue
is array-like, elsefalse
.Example 1
_.isArrayLike([1, 2, 3]); // => true
_.isArrayLike(document.body.children); // => true
_.isArrayLike('abc'); // => true
_.isArrayLike(_.noop); // => false
See Also
_.isArrayLike
interface LoDashStatic
interface LoDashStatic {}
method isArrayLikeObject
isArrayLikeObject: { <T extends { __lodashAnyHack: any }>(value: T): boolean; ( value: | string | number | boolean | globalThis.Function | ((...args: any[]) => any) ): value is never; (value: any): value is object & { length: number };};
This method is like
_.isArrayLike
except that it also checks ifvalue
is an object.Lang
Parameter value
The value to check.
Returns
Returns
true
ifvalue
is an array-like object, elsefalse
.Example 1
_.isArrayLikeObject([1, 2, 3]); // => true
_.isArrayLikeObject(document.body.children); // => true
_.isArrayLikeObject('abc'); // => false
_.isArrayLikeObject(_.noop); // => false
See Also
_.isArrayLikeObject
interface LoDashStatic
interface LoDashStatic {}
method isBoolean
isBoolean: (value?: any) => value is boolean;
Checks if value is classified as a boolean primitive or object.
Parameter value
The value to check. Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isBuffer
isBuffer: (value?: any) => boolean;
Checks if value is a buffer.
Parameter value
The value to check. Returns true if value is a buffer, else false.
interface LoDashStatic
interface LoDashStatic {}
method isDate
isDate: (value?: any) => value is Date;
Checks if value is classified as a Date object.
Parameter value
The value to check.
Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isElement
isElement: (value?: any) => boolean;
Checks if value is a DOM element.
Parameter value
The value to check. Returns true if value is a DOM element, else false.
interface LoDashStatic
interface LoDashStatic {}
method isEmpty
isEmpty: { <T extends { __trapAny: any }>(value?: T): boolean; (value: string): value is ''; (value: List<any> | Map<any, any> | Set<any>): boolean; (value: object): boolean; <T extends object>(value: T): value is EmptyObjectOf<T>; (value?: any): boolean;};
Checks if value is empty. A value is considered empty unless it’s an arguments object, array, string, or jQuery-like collection with a length greater than 0 or an object with own enumerable properties.
Parameter value
The value to inspect. Returns true if value is empty, else false.
interface LoDashStatic
interface LoDashStatic {}
method isEqual
isEqual: (value: any, other: any) => boolean;
Performs a deep comparison between two values to determine if they are equivalent.
**Note:** This method supports comparing arrays, array buffers, booleans, date objects, error objects, maps, numbers,
Object
objects, regexes, sets, strings, symbols, and typed arrays.Object
objects are compared by their own, not inherited, enumerable properties. Functions and DOM nodes are **not** supported.Lang
Parameter value
The value to compare.
Parameter other
The other value to compare.
Returns
Returns
true
if the values are equivalent, elsefalse
.Example 1
var object = { 'user': 'fred' }; var other = { 'user': 'fred' };
_.isEqual(object, other); // => true
object === other; // => false
interface LoDashStatic
interface LoDashStatic {}
method isEqualWith
isEqualWith: (value: any, other: any, customizer?: IsEqualCustomizer) => boolean;
This method is like
_.isEqual
except that it acceptscustomizer
which is invoked to compare values. Ifcustomizer
returnsundefined
comparisons are handled by the method instead. Thecustomizer
is invoked with up to seven arguments: (objValue, othValue [, index|key, object, other, stack]).Lang
Parameter value
The value to compare.
Parameter other
The other value to compare.
Parameter customizer
The function to customize comparisons.
Returns
Returns
true
if the values are equivalent, elsefalse
.Example 1
function isGreeting(value) { return /^h(?:i|ello)$/.test(value); }
function customizer(objValue, othValue) { if (isGreeting(objValue) && isGreeting(othValue)) { return true; } }
var array = ['hello', 'goodbye']; var other = ['hi', 'goodbye'];
_.isEqualWith(array, other, customizer); // => true
interface LoDashStatic
interface LoDashStatic {}
method isError
isError: (value: any) => value is Error;
Checks if value is an Error, EvalError, RangeError, ReferenceError, SyntaxError, TypeError, or URIError object.
Parameter value
The value to check. Returns true if value is an error object, else false.
interface LoDashStatic
interface LoDashStatic {}
method isFinite
isFinite: (value?: any) => boolean;
Checks if value is a finite primitive number.
Note: This method is based on Number.isFinite.
Parameter value
The value to check. Returns true if value is a finite number, else false.
interface LoDashStatic
interface LoDashStatic {}
method isFunction
isFunction: (value: any) => value is (...args: any[]) => any;
Checks if value is a callable function.
Parameter value
The value to check. Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isInteger
isInteger: (value?: any) => boolean;
Checks if
value
is an integer.**Note:** This method is based on [
Number.isInteger
](https://mdn.io/Number/isInteger).Lang
Parameter value
The value to check.
Returns
Returns
true
ifvalue
is an integer, elsefalse
.Example 1
_.isInteger(3); // => true
_.isInteger(Number.MIN_VALUE); // => false
_.isInteger(Infinity); // => false
_.isInteger('3'); // => false
interface LoDashStatic
interface LoDashStatic {}
method isLength
isLength: (value?: any) => boolean;
Checks if
value
is a valid array-like length.**Note:** This function is loosely based on [
ToLength
](http://ecma-international.org/ecma-262/6.0/#sec-tolength).Lang
Parameter value
The value to check.
Returns
Returns
true
ifvalue
is a valid length, elsefalse
.Example 1
_.isLength(3); // => true
_.isLength(Number.MIN_VALUE); // => false
_.isLength(Infinity); // => false
_.isLength('3'); // => false
interface LoDashStatic
interface LoDashStatic {}
method isMap
isMap: (value?: any) => value is Map<any, any>;
Checks if value is classified as a Map object.
Parameter value
The value to check.
Returns
Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isMatch
isMatch: (object: object, source: object) => boolean;
Performs a deep comparison between
object
andsource
to determine ifobject
contains equivalent property values.**Note:** This method supports comparing the same values as
_.isEqual
.Lang
Parameter object
The object to inspect.
Parameter source
The object of property values to match.
Returns
Returns
true
ifobject
is a match, elsefalse
.Example 1
var object = { 'user': 'fred', 'age': 40 };
_.isMatch(object, { 'age': 40 }); // => true
_.isMatch(object, { 'age': 36 }); // => false
interface LoDashStatic
interface LoDashStatic {}
method isMatchWith
isMatchWith: ( object: object, source: object, customizer: isMatchWithCustomizer) => boolean;
This method is like
_.isMatch
except that it acceptscustomizer
which is invoked to compare values. Ifcustomizer
returnsundefined
comparisons are handled by the method instead. Thecustomizer
is invoked with three arguments: (objValue, srcValue, index|key, object, source).Lang
Parameter object
The object to inspect.
Parameter source
The object of property values to match.
Parameter customizer
The function to customize comparisons.
Returns
Returns
true
ifobject
is a match, elsefalse
.Example 1
function isGreeting(value) { return /^h(?:i|ello)$/.test(value); }
function customizer(objValue, srcValue) { if (isGreeting(objValue) && isGreeting(srcValue)) { return true; } }
var object = { 'greeting': 'hello' }; var source = { 'greeting': 'hi' };
_.isMatchWith(object, source, customizer); // => true
interface LoDashStatic
interface LoDashStatic {}
method isNaN
isNaN: (value?: any) => boolean;
Checks if value is NaN.
Note: This method is not the same as isNaN which returns true for undefined and other non-numeric values.
Parameter value
The value to check. Returns true if value is NaN, else false.
interface LoDashStatic
interface LoDashStatic {}
method isNative
isNative: (value: any) => value is (...args: any[]) => any;
Checks if value is a native function.
Parameter value
The value to check.
Returns true if value is a native function, else false.
interface LoDashStatic
interface LoDashStatic {}
method isNil
isNil: (value: any) => value is null;
Checks if
value
isnull
orundefined
.Lang
Parameter value
The value to check.
Returns
Returns
true
ifvalue
is nullish, elsefalse
.Example 1
_.isNil(null); // => true
_.isNil(void 0); // => true
_.isNil(NaN); // => false
interface LoDashStatic
interface LoDashStatic {}
method isNull
isNull: (value: any) => value is null;
Checks if value is null.
Parameter value
The value to check. Returns true if value is null, else false.
interface LoDashStatic
interface LoDashStatic {}
method isNumber
isNumber: (value?: any) => value is number;
Checks if value is classified as a Number primitive or object.
Note: To exclude Infinity, -Infinity, and NaN, which are classified as numbers, use the _.isFinite method.
Parameter value
The value to check. Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isObject
isObject: (value?: any) => value is object;
Checks if value is the language type of Object. (e.g. arrays, functions, objects, regexes, new Number(0), and new String(''))
Parameter value
The value to check. Returns true if value is an object, else false.
interface LoDashStatic
interface LoDashStatic {}
method isObjectLike
isObjectLike: (value?: any) => boolean;
Checks if
value
is object-like. A value is object-like if it's notnull
and has atypeof
result of "object".Lang
Parameter value
The value to check.
Returns
Returns
true
ifvalue
is object-like, elsefalse
.Example 1
_.isObjectLike({}); // => true
_.isObjectLike([1, 2, 3]); // => true
_.isObjectLike(_.noop); // => false
_.isObjectLike(null); // => false
interface LoDashStatic
interface LoDashStatic {}
method isPlainObject
isPlainObject: (value?: any) => boolean;
Checks if value is a plain object, that is, an object created by the Object constructor or one with a [[Prototype]] of null.
Note: This method assumes objects created by the Object constructor have no inherited enumerable properties.
Parameter value
The value to check. Returns true if value is a plain object, else false.
interface LoDashStatic
interface LoDashStatic {}
method isRegExp
isRegExp: (value?: any) => value is RegExp;
Checks if value is classified as a RegExp object.
Parameter value
The value to check.
Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isSafeInteger
isSafeInteger: (value: any) => boolean;
Checks if
value
is a safe integer. An integer is safe if it's an IEEE-754 double precision number which isn't the result of a rounded unsafe integer.**Note:** This method is based on [
Number.isSafeInteger
](https://mdn.io/Number/isSafeInteger).Lang
Parameter value
The value to check.
Returns
Returns
true
ifvalue
is a safe integer, elsefalse
.Example 1
_.isSafeInteger(3); // => true
_.isSafeInteger(Number.MIN_VALUE); // => false
_.isSafeInteger(Infinity); // => false
_.isSafeInteger('3'); // => false
interface LoDashStatic
interface LoDashStatic {}
method isSet
isSet: (value?: any) => value is Set<any>;
Checks if value is classified as a Set object.
Parameter value
The value to check.
Returns
Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isString
isString: (value?: any) => value is string;
Checks if value is classified as a String primitive or object.
Parameter value
The value to check. Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isSymbol
isSymbol: (value: any) => value is symbol;
Checks if
value
is classified as aSymbol
primitive or object.Lang
Parameter value
The value to check.
Returns
Returns
true
ifvalue
is correctly classified, elsefalse
.Example 1
_.isSymbol(Symbol.iterator); // => true
_.isSymbol('abc'); // => false
interface LoDashStatic
interface LoDashStatic {}
method isTypedArray
isTypedArray: (value: any) => boolean;
Checks if value is classified as a typed array.
Parameter value
The value to check. Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isUndefined
isUndefined: (value: any) => value is undefined;
Checks if value is undefined.
Parameter value
The value to check. Returns true if value is undefined, else false.
interface LoDashStatic
interface LoDashStatic {}
method isWeakMap
isWeakMap: (value?: any) => value is WeakMap<object, any>;
Checks if value is classified as a WeakMap object.
Parameter value
The value to check.
Returns
Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method isWeakSet
isWeakSet: (value?: any) => value is WeakSet<object>;
Checks if value is classified as a WeakSet object.
Parameter value
The value to check.
Returns
Returns true if value is correctly classified, else false.
interface LoDashStatic
interface LoDashStatic {}
method lt
lt: (value: any, other: any) => boolean;
Checks if value is less than other.
Parameter value
The value to compare.
Parameter other
The other value to compare. Returns true if value is less than other, else false.
interface LoDashStatic
interface LoDashStatic {}
method lte
lte: (value: any, other: any) => boolean;
Checks if value is less than or equal to other.
Parameter value
The value to compare.
Parameter other
The other value to compare. Returns true if value is less than or equal to other, else false.
interface LoDashStatic
interface LoDashStatic {}
method toArray
toArray: { <T>(value: Dictionary<T> | NumericDictionary<T> | null | undefined): T[]; <T>(value: T): T[keyof T][]; (): any[];};
Converts value to an array.
Parameter value
The value to convert. Returns the converted array.
See Also
_.toArray
interface LoDashStatic
interface LoDashStatic {}
method toFinite
toFinite: (value: any) => number;
Converts
value
to a finite number.4.12.0 Lang
Parameter value
The value to convert.
Returns
Returns the converted number.
Example 1
_.toFinite(3.2); // => 3.2
_.toFinite(Number.MIN_VALUE); // => 5e-324
_.toFinite(Infinity); // => 1.7976931348623157e+308
_.toFinite('3.2'); // => 3.2
interface LoDashStatic
interface LoDashStatic {}
method toInteger
toInteger: (value: any) => number;
Converts
value
to an integer.**Note:** This function is loosely based on [
ToInteger
](http://www.ecma-international.org/ecma-262/6.0/#sec-tointeger).Lang
Parameter value
The value to convert.
Returns
Returns the converted integer.
Example 1
_.toInteger(3); // => 3
_.toInteger(Number.MIN_VALUE); // => 0
_.toInteger(Infinity); // => 1.7976931348623157e+308
_.toInteger('3'); // => 3
interface LoDashStatic
interface LoDashStatic {}
method toLength
toLength: (value: any) => number;
Converts
value
to an integer suitable for use as the length of an array-like object.**Note:** This method is based on [
ToLength
](http://ecma-international.org/ecma-262/6.0/#sec-tolength).Lang
Parameter value
The value to convert. Returns the converted integer.
Example 1
_.toLength(3); // => 3
_.toLength(Number.MIN_VALUE); // => 0
_.toLength(Infinity); // => 4294967295
_.toLength('3'); // => 3
interface LoDashStatic
interface LoDashStatic {}
method toNumber
toNumber: (value: any) => number;
Converts
value
to a number.Lang
Parameter value
The value to process.
Returns
Returns the number.
Example 1
_.toNumber(3); // => 3
_.toNumber(Number.MIN_VALUE); // => 5e-324
_.toNumber(Infinity); // => Infinity
_.toNumber('3'); // => 3
interface LoDashStatic
interface LoDashStatic {}
method toPlainObject
toPlainObject: (value?: any) => any;
Converts value to a plain object flattening inherited enumerable properties of value to own properties of the plain object.
Parameter value
The value to convert. Returns the converted plain object.
interface LoDashStatic
interface LoDashStatic {}
method toSafeInteger
toSafeInteger: (value: any) => number;
Converts
value
to a safe integer. A safe integer can be compared and represented correctly.Lang
Parameter value
The value to convert.
Returns
Returns the converted integer.
Example 1
_.toSafeInteger(3); // => 3
_.toSafeInteger(Number.MIN_VALUE); // => 0
_.toSafeInteger(Infinity); // => 9007199254740991
_.toSafeInteger('3'); // => 3
interface LoDashStatic
interface LoDashStatic {}
method toString
toString: (value: any) => string;
Converts
value
to a string if it's not one. An empty string is returned fornull
andundefined
values. The sign of-0
is preserved.Lang
Parameter value
The value to process.
Returns
Returns the string.
Example 1
_.toString(null); // => ''
_.toString(-0); // => '-0'
_.toString([1, 2, 3]); // => '1,2,3'
interface LoDashStatic
interface LoDashStatic {}
method add
add: (augend: number, addend: number) => number;
Adds two numbers.
Parameter augend
The first number to add.
Parameter addend
The second number to add. Returns the sum.
interface LoDashStatic
interface LoDashStatic {}
method ceil
ceil: (n: number, precision?: number) => number;
Calculates n rounded up to precision.
Parameter n
The number to round up.
Parameter precision
The precision to round up to. Returns the rounded up number.
interface LoDashStatic
interface LoDashStatic {}
method divide
divide: (dividend: number, divisor: number) => number;
Divide two numbers.
Parameter dividend
The first number in a division.
Parameter divisor
The second number in a division.
Returns
Returns the quotient.
interface LoDashStatic
interface LoDashStatic {}
method floor
floor: (n: number, precision?: number) => number;
Calculates n rounded down to precision.
Parameter n
The number to round down.
Parameter precision
The precision to round down to. Returns the rounded down number.
interface LoDashStatic
interface LoDashStatic {}
method max
max: <T>(collection: List<T> | null | undefined) => T | undefined;
Computes the maximum value of
array
. Ifarray
is empty or falseyundefined
is returned.Math
Parameter array
The array to iterate over.
Returns
Returns the maximum value.
interface LoDashStatic
interface LoDashStatic {}
method maxBy
maxBy: <T>( collection: List<T> | null | undefined, iteratee?: ValueIteratee<T>) => T | undefined;
This method is like
_.max
except that it acceptsiteratee
which is invoked for each element inarray
to generate the criterion by which the value is ranked. The iteratee is invoked with one argument: (value).Math
Parameter array
The array to iterate over.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the maximum value.
Example 1
var objects = [{ 'n': 1 }, { 'n': 2 }];
_.maxBy(objects, function(o) { return o.n; }); // => { 'n': 2 }
// using the
_.property
iteratee shorthand _.maxBy(objects, 'n'); // => { 'n': 2 }
interface LoDashStatic
interface LoDashStatic {}
method mean
mean: (collection: List<any> | null | undefined) => number;
Computes the mean of the values in
array
.Math
Parameter array
The array to iterate over.
Returns
Returns the mean.
Example 1
_.mean([4, 2, 8, 6]); // => 5
interface LoDashStatic
interface LoDashStatic {}
method meanBy
meanBy: <T>( collection: List<T> | null | undefined, iteratee?: ValueIteratee<T>) => number;
Computes the mean of the provided properties of the objects in the
array
Math
Parameter array
The array to iterate over.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the mean.
Example 1
_.mean([{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }], 'n'); // => 5
interface LoDashStatic
interface LoDashStatic {}
method min
min: <T>(collection: List<T> | null | undefined) => T | undefined;
Computes the minimum value of
array
. Ifarray
is empty or falseyundefined
is returned.Math
Parameter array
The array to iterate over.
Returns
Returns the minimum value.
interface LoDashStatic
interface LoDashStatic {}
method minBy
minBy: <T>( collection: List<T> | null | undefined, iteratee?: ValueIteratee<T>) => T | undefined;
This method is like
_.min
except that it acceptsiteratee
which is invoked for each element inarray
to generate the criterion by which the value is ranked. The iteratee is invoked with one argument: (value).Math
Parameter array
The array to iterate over.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the minimum value.
Example 1
var objects = [{ 'n': 1 }, { 'n': 2 }];
_.minBy(objects, function(o) { return o.a; }); // => { 'n': 1 }
// using the
_.property
iteratee shorthand _.minBy(objects, 'n'); // => { 'n': 1 }
interface LoDashStatic
interface LoDashStatic {}
method multiply
multiply: (multiplier: number, multiplicand: number) => number;
Multiply two numbers.
Parameter multiplier
The first number in a multiplication.
Parameter multiplicand
The second number in a multiplication.
Returns
Returns the product.
interface LoDashStatic
interface LoDashStatic {}
method round
round: (n: number, precision?: number) => number;
Calculates n rounded to precision.
Parameter n
The number to round.
Parameter precision
The precision to round to. Returns the rounded number.
interface LoDashStatic
interface LoDashStatic {}
method subtract
subtract: (minuend: number, subtrahend: number) => number;
Subtract two numbers.
Math
Parameter minuend
The first number in a subtraction.
Parameter subtrahend
The second number in a subtraction.
Returns
Returns the difference.
Example 1
_.subtract(6, 4); // => 2
interface LoDashStatic
interface LoDashStatic {}
method sum
sum: (collection: List<any> | null | undefined) => number;
Computes the sum of the values in
array
.Math
Parameter array
The array to iterate over.
Returns
Returns the sum.
Example 1
_.sum([4, 2, 8, 6]); // => 20
interface LoDashStatic
interface LoDashStatic {}
method sumBy
sumBy: <T>( collection: List<T> | null | undefined, iteratee?: string | ((value: T) => number)) => number;
This method is like
_.sum
except that it acceptsiteratee
which is invoked for each element inarray
to generate the value to be summed. The iteratee is invoked with one argument: (value).Math
Parameter array
The array to iterate over.
Parameter iteratee
The iteratee invoked per element.
Returns
Returns the sum.
Example 1
var objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }];
_.sumBy(objects, function(o) { return o.n; }); // => 20
// using the
_.property
iteratee shorthand _.sumBy(objects, 'n'); // => 20
interface LoDashStatic
interface LoDashStatic {}
method clamp
clamp: { (number: number, lower: number, upper: number): number; (number: number, upper: number): number;};
Clamps
number
within the inclusivelower
andupper
bounds.Number
Parameter number
The number to clamp.
Parameter lower
The lower bound.
Parameter upper
The upper bound.
Parameter number
The number to clamp.
Parameter lower
The lower bound.
Parameter upper
The upper bound.
Returns
Returns the clamped number.
Example 1
_.clamp(-10, -5, 5); // => -5
_.clamp(10, -5, 5); // => 5 Clamps
number
within the inclusivelower
andupper
bounds.Number
Example 2
_.clamp(-10, -5, 5); // => -5
_.clamp(10, -5, 5);
See Also
_.clamp
interface LoDashStatic
interface LoDashStatic {}
method inRange
inRange: (n: number, start: number, end?: number) => boolean;
Checks if n is between start and up to but not including, end. If end is not specified it’s set to start with start then set to 0.
Parameter n
The number to check.
Parameter start
The start of the range.
Parameter end
The end of the range. Returns true if n is in the range, else false.
interface LoDashStatic
interface LoDashStatic {}
method random
random: { (floating?: boolean): number; (max: number, floating?: boolean): number; (min: number, max: number, floating?: boolean): number; (min: number, index: string | number, guard: object): number;};
Produces a random number between min and max (inclusive). If only one argument is provided a number between 0 and the given number is returned. If floating is true, or either min or max are floats, a floating-point number is returned instead of an integer.
Parameter min
The minimum possible value.
Parameter max
The maximum possible value.
Parameter floating
Specify returning a floating-point number. Returns the random number.
See Also
_.random
interface LoDashStatic
interface LoDashStatic {}
method assign
assign: { <TObject, TSource>(object: TObject, source: TSource): TObject & TSource; <TObject, TSource1, TSource2>( object: TObject, source1: TSource1, source2: TSource2 ): TObject & TSource1 & TSource2; <TObject, TSource1, TSource2, TSource3>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3 ): TObject & TSource1 & TSource2 & TSource3; <TObject, TSource1, TSource2, TSource3, TSource4>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): TObject & TSource1 & TSource2 & TSource3 & TSource4; <TObject>(object: TObject): TObject; (object: any, ...otherArgs: any[]): any;};
Assigns own enumerable properties of source objects to the destination object. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.
**Note:** This method mutates
object
and is loosely based on [Object.assign
](https://mdn.io/Object/assign).Object
Parameter object
The destination object.
Parameter sources
The source objects.
Returns
Returns
object
.Example 1
function Foo() { this.c = 3; }
function Bar() { this.e = 5; }
Foo.prototype.d = 4; Bar.prototype.f = 6;
_.assign({ 'a': 1 }, new Foo, new Bar); // => { 'a': 1, 'c': 3, 'e': 5 }
See Also
_.assign
interface LoDashStatic
interface LoDashStatic {}
method assignIn
assignIn: { <TObject, TSource>(object: TObject, source: TSource): TObject & TSource; <TObject, TSource1, TSource2>( object: TObject, source1: TSource1, source2: TSource2 ): TObject & TSource1 & TSource2; <TObject, TSource1, TSource2, TSource3>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3 ): TObject & TSource1 & TSource2 & TSource3; <TObject, TSource1, TSource2, TSource3, TSource4>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): TObject & TSource1 & TSource2 & TSource3 & TSource4; <TObject>(object: TObject): TObject; <TResult>(object: any, ...otherArgs: any[]): TResult;};
This method is like
_.assign
except that it iterates over own and inherited source properties.**Note:** This method mutates
object
.extend Object
Parameter object
The destination object.
Parameter sources
The source objects.
Returns
Returns
object
.Example 1
function Foo() { this.b = 2; }
function Bar() { this.d = 4; }
Foo.prototype.c = 3; Bar.prototype.e = 5;
_.assignIn({ 'a': 1 }, new Foo, new Bar); // => { 'a': 1, 'b': 2, 'c': 3, 'd': 4, 'e': 5 }
See Also
_.assignIn
interface LoDashStatic
interface LoDashStatic {}
method assignInWith
assignInWith: { <TObject, TSource>( object: TObject, source: TSource, customizer: AssignCustomizer ): TObject & TSource; <TObject, TSource1, TSource2>( object: TObject, source1: TSource1, source2: TSource2, customizer: AssignCustomizer ): TObject & TSource1 & TSource2; <TObject, TSource1, TSource2, TSource3>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer ): TObject & TSource1 & TSource2 & TSource3; <TObject, TSource1, TSource2, TSource3, TSource4>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer ): TObject & TSource1 & TSource2 & TSource3 & TSource4; <TObject>(object: TObject): TObject; <TResult>(object: any, ...otherArgs: any[]): TResult;};
This method is like
_.assignIn
except that it acceptscustomizer
which is invoked to produce the assigned values. Ifcustomizer
returnsundefined
assignment is handled by the method instead. Thecustomizer
is invoked with five arguments: (objValue, srcValue, key, object, source).**Note:** This method mutates
object
.extendWith Object
Parameter object
The destination object.
Parameter sources
The source objects.
Parameter customizer
The function to customize assigned values.
Returns
Returns
object
.Example 1
function customizer(objValue, srcValue) { return _.isUndefined(objValue) ? srcValue : objValue; }
var defaults = _.partialRight(_.assignInWith, customizer);
defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 }); // => { 'a': 1, 'b': 2 }
See Also
_.assignInWith
interface LoDashStatic
interface LoDashStatic {}
method assignWith
assignWith: { <TObject, TSource>( object: TObject, source: TSource, customizer: AssignCustomizer ): TObject & TSource; <TObject, TSource1, TSource2>( object: TObject, source1: TSource1, source2: TSource2, customizer: AssignCustomizer ): TObject & TSource1 & TSource2; <TObject, TSource1, TSource2, TSource3>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer ): TObject & TSource1 & TSource2 & TSource3; <TObject, TSource1, TSource2, TSource3, TSource4>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer ): TObject & TSource1 & TSource2 & TSource3 & TSource4; <TObject>(object: TObject): TObject; <TResult>(object: any, ...otherArgs: any[]): TResult;};
This method is like
_.assign
except that it acceptscustomizer
which is invoked to produce the assigned values. Ifcustomizer
returnsundefined
assignment is handled by the method instead. Thecustomizer
is invoked with five arguments: (objValue, srcValue, key, object, source).**Note:** This method mutates
object
.Object
Parameter object
The destination object.
Parameter sources
The source objects.
Parameter customizer
The function to customize assigned values.
Returns
Returns
object
.Example 1
function customizer(objValue, srcValue) { return _.isUndefined(objValue) ? srcValue : objValue; }
var defaults = _.partialRight(_.assignWith, customizer);
defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 }); // => { 'a': 1, 'b': 2 }
See Also
_.assignWith
interface LoDashStatic
interface LoDashStatic {}
method at
at: { <T>( object: Dictionary<T> | NumericDictionary<T> | null | undefined, ...props: PropertyPath[] ): T[]; <T extends object>(object: T, ...props: Many<keyof T>[]): T[keyof T][];};
Creates an array of elements corresponding to the given keys, or indexes, of collection. Keys may be specified as individual arguments or as arrays of keys.
Parameter object
The object to iterate over.
Parameter props
The property names or indexes of elements to pick, specified individually or in arrays. Returns the new array of picked elements.
See Also
_.at
interface LoDashStatic
interface LoDashStatic {}
method create
create: <T extends object, U extends object>( prototype: T, properties?: U) => T & U;
Creates an object that inherits from the given prototype object. If a properties object is provided its own enumerable properties are assigned to the created object.
Parameter prototype
The object to inherit from.
Parameter properties
The properties to assign to the object. Returns the new object.
interface LoDashStatic
interface LoDashStatic {}
method defaults
defaults: { <TObject, TSource>(object: TObject, source: TSource): NonNullable< TSource & TObject >; <TObject, TSource1, TSource2>( object: TObject, source1: TSource1, source2: TSource2 ): NonNullable<TSource2 & TSource1 & TObject>; <TObject, TSource1, TSource2, TSource3>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3 ): NonNullable<TSource3 & TSource2 & TSource1 & TObject>; <TObject, TSource1, TSource2, TSource3, TSource4>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): NonNullable<TSource4 & TSource3 & TSource2 & TSource1 & TObject>; <TObject>(object: TObject): NonNullable<TObject>; (object: any, ...sources: any[]): any;};
Assigns own enumerable properties of source object(s) to the destination object for all destination properties that resolve to undefined. Once a property is set, additional values of the same property are ignored.
Note: This method mutates object.
Parameter object
The destination object.
Parameter sources
The source objects. The destination object.
See Also
_.defaults
interface LoDashStatic
interface LoDashStatic {}
method defaultsDeep
defaultsDeep: (object: any, ...sources: any[]) => any;
This method is like _.defaults except that it recursively assigns default properties.
Parameter object
The destination object.
Parameter sources
The source objects. Returns object.
interface LoDashStatic
interface LoDashStatic {}
method entries
entries: { <T>(object?: Dictionary<T> | NumericDictionary<T>): Array<[string, T]>; (object?: object): [string, any][];};
See Also
_.toPairs
See Also
_.entries
interface LoDashStatic
interface LoDashStatic {}
method entriesIn
entriesIn: { <T>(object?: Dictionary<T> | NumericDictionary<T>): Array<[string, T]>; (object?: object): [string, any][];};
See Also
_.entriesIn
interface LoDashStatic
interface LoDashStatic {}
method extend
extend: { <TObject, TSource>(object: TObject, source: TSource): TObject & TSource; <TObject, TSource1, TSource2>( object: TObject, source1: TSource1, source2: TSource2 ): TObject & TSource1 & TSource2; <TObject, TSource1, TSource2, TSource3>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3 ): TObject & TSource1 & TSource2 & TSource3; <TObject, TSource1, TSource2, TSource3, TSource4>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): TObject & TSource1 & TSource2 & TSource3 & TSource4; <TObject>(object: TObject): TObject; <TResult>(object: any, ...otherArgs: any[]): TResult;};
See Also
_.extend
interface LoDashStatic
interface LoDashStatic {}
method extendWith
extendWith: { <TObject, TSource>( object: TObject, source: TSource, customizer: AssignCustomizer ): TObject & TSource; <TObject, TSource1, TSource2>( object: TObject, source1: TSource1, source2: TSource2, customizer: AssignCustomizer ): TObject & TSource1 & TSource2; <TObject, TSource1, TSource2, TSource3>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer ): TObject & TSource1 & TSource2 & TSource3; <TObject, TSource1, TSource2, TSource3, TSource4>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer ): TObject & TSource1 & TSource2 & TSource3 & TSource4; <TObject>(object: TObject): TObject; <TResult>(object: any, ...otherArgs: any[]): TResult;};
See Also
_.extendWith
interface LoDashStatic
interface LoDashStatic {}
method findKey
findKey: <T>( object: T | null | undefined, predicate?: ObjectIteratee<T>) => string | undefined;
This method is like _.find except that it returns the key of the first element predicate returns truthy for instead of the element itself.
Parameter object
The object to search.
Parameter predicate
The function invoked per iteration. Returns the key of the matched element, else undefined.
interface LoDashStatic
interface LoDashStatic {}
method findLastKey
findLastKey: <T>( object: T | null | undefined, predicate?: ObjectIteratee<T>) => string | undefined;
This method is like _.findKey except that it iterates over elements of a collection in the opposite order.
Parameter object
The object to search.
Parameter predicate
The function invoked per iteration. Returns the key of the matched element, else undefined.
interface LoDashStatic
interface LoDashStatic {}
method forIn
forIn: { <T>(object: T, iteratee?: ObjectIterator<T, any>): T; <T>(object: T, iteratee?: ObjectIterator<T, any>): T;};
Iterates over own and inherited enumerable properties of an object invoking iteratee for each property. The iteratee is invoked with three arguments: (value, key, object). Iteratee functions may exit iteration early by explicitly returning false.
Parameter object
The object to iterate over.
Parameter iteratee
The function invoked per iteration. Returns object.
See Also
_.forIn
interface LoDashStatic
interface LoDashStatic {}
method forInRight
forInRight: { <T>(object: T, iteratee?: ObjectIterator<T, any>): T; <T>(object: T, iteratee?: ObjectIterator<T, any>): T;};
This method is like _.forIn except that it iterates over properties of object in the opposite order.
Parameter object
The object to iterate over.
Parameter iteratee
The function invoked per iteration. Returns object.
See Also
_.forInRight
interface LoDashStatic
interface LoDashStatic {}
method forOwn
forOwn: { <T>(object: T, iteratee?: ObjectIterator<T, any>): T; <T>(object: T, iteratee?: ObjectIterator<T, any>): T;};
Iterates over own enumerable properties of an object invoking iteratee for each property. The iteratee is invoked with three arguments: (value, key, object). Iteratee functions may exit iteration early by explicitly returning false.
Parameter object
The object to iterate over.
Parameter iteratee
The function invoked per iteration. Returns object.
See Also
_.forOwn
interface LoDashStatic
interface LoDashStatic {}
method forOwnRight
forOwnRight: { <T>(object: T, iteratee?: ObjectIterator<T, any>): T; <T>(object: T, iteratee?: ObjectIterator<T, any>): T;};
This method is like _.forOwn except that it iterates over properties of object in the opposite order.
Parameter object
The object to iterate over.
Parameter iteratee
The function invoked per iteration. Returns object.
See Also
_.forOwnRight
interface LoDashStatic
interface LoDashStatic {}
method functions
functions: (object: any) => string[];
Creates an array of function property names from own enumerable properties of
object
.Object
Parameter object
The object to inspect.
Returns
Returns the new array of property names.
Example 1
function Foo() { this.a = _.constant('a'); this.b = _.constant('b'); }
Foo.prototype.c = _.constant('c');
_.functions(new Foo); // => ['a', 'b']
interface LoDashStatic
interface LoDashStatic {}
method functionsIn
functionsIn: <T extends {}>(object: any) => string[];
Creates an array of function property names from own and inherited enumerable properties of
object
.Object
Parameter object
The object to inspect.
Returns
Returns the new array of property names.
Example 1
function Foo() { this.a = _.constant('a'); this.b = _.constant('b'); }
Foo.prototype.c = _.constant('c');
_.functionsIn(new Foo); // => ['a', 'b', 'c']
interface LoDashStatic
interface LoDashStatic {}
method get
get: { <TObject extends object, TKey extends keyof TObject>( object: TObject, path: TKey | [TKey] ): TObject[TKey]; <TObject extends object, TKey extends keyof TObject>( object: TObject, path: TKey | [TKey] ): TObject[TKey]; <TObject extends object, TKey extends keyof TObject, TDefault>( object: TObject, path: TKey | [TKey], defaultValue: TDefault ): TDefault | Exclude<TObject[TKey], undefined>; < TObject extends object, TKey1 extends keyof TObject, TKey2 extends keyof TObject[TKey1] >( object: TObject, path: [TKey1, TKey2] ): TObject[TKey1][TKey2]; < TObject extends object, TKey1 extends keyof TObject, TKey2 extends keyof NonNullable<TObject[TKey1]> >( object: TObject, path: [TKey1, TKey2] ): NonNullable<TObject[TKey1]>[TKey2]; < TObject extends object, TKey1 extends keyof TObject, TKey2 extends keyof NonNullable<TObject[TKey1]>, TDefault >( object: TObject, path: [TKey1, TKey2], defaultValue: TDefault ): TDefault | Exclude<NonNullable<TObject[TKey1]>[TKey2], undefined>; < TObject extends object, TKey1 extends keyof TObject, TKey2 extends keyof TObject[TKey1], TKey3 extends keyof TObject[TKey1][TKey2] >( object: TObject, path: [TKey1, TKey2, TKey3] ): TObject[TKey1][TKey2][TKey3]; < TObject extends object, TKey1 extends keyof TObject, TKey2 extends keyof NonNullable<TObject[TKey1]>, TKey3 extends keyof NonNullable<NonNullable<TObject[TKey1]>[TKey2]> >( object: TObject, path: [TKey1, TKey2, TKey3] ): NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]; < TObject extends object, TKey1 extends keyof TObject, TKey2 extends keyof NonNullable<TObject[TKey1]>, TKey3 extends keyof NonNullable<NonNullable<TObject[TKey1]>[TKey2]>, TDefault >( object: TObject, path: [TKey1, TKey2, TKey3], defaultValue: TDefault ): | TDefault | Exclude< NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3], undefined >; < TObject extends object, TKey1 extends keyof TObject, TKey2 extends keyof TObject[TKey1], TKey3 extends keyof TObject[TKey1][TKey2], TKey4 extends keyof TObject[TKey1][TKey2][TKey3] >( object: TObject, path: [TKey1, TKey2, TKey3, TKey4] ): TObject[TKey1][TKey2][TKey3][TKey4]; < TObject extends object, TKey1 extends keyof TObject, TKey2 extends keyof NonNullable<TObject[TKey1]>, TKey3 extends keyof NonNullable<NonNullable<TObject[TKey1]>[TKey2]>, TKey4 extends keyof NonNullable< NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3] > >( object: TObject, path: [TKey1, TKey2, TKey3, TKey4] ): NonNullable< NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3] >[TKey4]; < TObject extends object, TKey1 extends keyof TObject, TKey2 extends keyof NonNullable<TObject[TKey1]>, TKey3 extends keyof NonNullable<NonNullable<TObject[TKey1]>[TKey2]>, TKey4 extends keyof NonNullable< NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3] >, TDefault >( object: TObject, path: [TKey1, TKey2, TKey3, TKey4], defaultValue: TDefault ): | TDefault | Exclude< NonNullable< NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3] >[TKey4], undefined >; <T>(object: NumericDictionary<T>, path: number): T; <T>(object: NumericDictionary<T>, path: number): T; <T, TDefault>( object: NumericDictionary<T>, path: number, defaultValue: TDefault ): T | TDefault; <TDefault>( object: null, path: PropertyPath, defaultValue: TDefault ): TDefault; (object: null, path: PropertyPath): undefined; <TObject, TPath extends string>( data: TObject, path: TPath ): string extends TPath ? any : GetFieldType<TObject, TPath, 'Path'>; < TObject, TPath extends string, TDefault = GetFieldType<TObject, TPath, 'Path'> >( data: TObject, path: TPath, defaultValue: TDefault ): TDefault | Exclude<GetFieldType<TObject, TPath, 'Path'>, null>; (object: any, path: PropertyPath, defaultValue?: any): any;};
Gets the property value at path of object. If the resolved value is undefined the defaultValue is used in its place.
Parameter object
The object to query.
Parameter path
The path of the property to get.
Parameter defaultValue
The value returned if the resolved value is undefined. Returns the resolved value.
See Also
_.get
interface LoDashStatic
interface LoDashStatic {}
method has
has: { <T, K extends PropertyName>(object: T, path: K): object is T & { [P in K]: P extends keyof T ? T[P] : Record<string, unknown> extends T ? T[keyof T] : unknown; } & { [uniqueSymbol]: unknown }; <T>(object: T, path: PropertyPath): boolean;};
Checks if
path
is a direct property ofobject
.Object
Parameter object
The object to query.
Parameter path
The path to check.
Returns
Returns
true
ifpath
exists, elsefalse
.Example 1
var object = { 'a': { 'b': { 'c': 3 } } }; var other = _.create({ 'a': _.create({ 'b': _.create({ 'c': 3 }) }) });
_.has(object, 'a'); // => true
_.has(object, 'a.b.c'); // => true
_.has(object, ['a', 'b', 'c']); // => true
_.has(other, 'a'); // => false
interface LoDashStatic
interface LoDashStatic {}
method hasIn
hasIn: <T>(object: T, path: PropertyPath) => boolean;
Checks if
path
is a direct or inherited property ofobject
.Object
Parameter object
The object to query.
Parameter path
The path to check.
Returns
Returns
true
ifpath
exists, elsefalse
.Example 1
var object = _.create({ 'a': _.create({ 'b': _.create({ 'c': 3 }) }) });
_.hasIn(object, 'a'); // => true
_.hasIn(object, 'a.b.c'); // => true
_.hasIn(object, ['a', 'b', 'c']); // => true
_.hasIn(object, 'b'); // => false
interface LoDashStatic
interface LoDashStatic {}
method invert
invert: (object: object) => Dictionary<string>;
Creates an object composed of the inverted keys and values of object. If object contains duplicate values, subsequent values overwrite property assignments of previous values unless multiValue is true.
Parameter object
The object to invert.
Parameter multiValue
Allow multiple values per key. Returns the new inverted object.
interface LoDashStatic
interface LoDashStatic {}
method invertBy
invertBy: { <T>( object: Dictionary<T> | NumericDictionary<T> | null | undefined, interatee?: ValueIteratee<T> ): Dictionary<string[]>; <T extends object>( object: T, interatee?: ValueIteratee<T[keyof T]> ): Dictionary<string[]>;};
This method is like _.invert except that the inverted object is generated from the results of running each element of object through iteratee. The corresponding inverted value of each inverted key is an array of keys responsible for generating the inverted value. The iteratee is invoked with one argument: (value).
Parameter object
The object to invert.
Parameter interatee
The iteratee invoked per element. Returns the new inverted object.
See Also
_.invertBy
interface LoDashStatic
interface LoDashStatic {}
method invoke
invoke: (object: any, path: PropertyPath, ...args: any[]) => any;
Invokes the method at path of object.
Parameter object
The object to query.
Parameter path
The path of the method to invoke.
Parameter args
The arguments to invoke the method with.
interface LoDashStatic
interface LoDashStatic {}
method keys
keys: (object?: any) => string[];
Creates an array of the own enumerable property names of object.
Note: Non-object values are coerced to objects. See the ES spec for more details.
Parameter object
The object to query. Returns the array of property names.
interface LoDashStatic
interface LoDashStatic {}
method keysIn
keysIn: (object?: any) => string[];
Creates an array of the own and inherited enumerable property names of object.
Note: Non-object values are coerced to objects.
Parameter object
The object to query. An array of property names.
interface LoDashStatic
interface LoDashStatic {}
method mapKeys
mapKeys: { <T>( object: List<T> | null | undefined, iteratee?: ListIteratee<T> ): Dictionary<T>; <T extends object>(object: T, iteratee?: ObjectIteratee<T>): Dictionary< T[keyof T] >;};
The opposite of _.mapValues; this method creates an object with the same values as object and keys generated by running each own enumerable property of object through iteratee.
Parameter object
The object to iterate over.
Parameter iteratee
The function invoked per iteration. Returns the new mapped object.
See Also
_.mapKeys
interface LoDashStatic
interface LoDashStatic {}
method mapValues
mapValues: { <TResult>( obj: string | null | undefined, callback: StringIterator<TResult> ): NumericDictionary<TResult>; <T, TResult>( array: T[], callback: ArrayIterator<T, TResult> ): NumericDictionary<TResult>; <T extends object, TResult>(obj: T, callback: ObjectIterator<T, TResult>): { [P in keyof T]: TResult; }; <T>( obj: Dictionary<T> | NumericDictionary<T>, iteratee: object ): Dictionary<boolean>; <T extends object>(obj: T, iteratee: object): { [P in keyof T]: boolean }; <T, TKey extends keyof T>( obj: Dictionary<T> | NumericDictionary<T>, iteratee: TKey ): Dictionary<T[TKey]>; <T>( obj: Dictionary<T> | NumericDictionary<T>, iteratee: string ): Dictionary<any>; <T extends object>(obj: T, iteratee: string): { [P in keyof T]: any }; (obj: string): NumericDictionary<string>; <T>(obj: Dictionary<T> | NumericDictionary<T>): Dictionary<T>; <T extends object>(obj: T): T; <T extends object>(obj: T): globalThis.Partial<T>;};
Creates an object with the same keys as object and values generated by running each own enumerable property of object through iteratee. The iteratee function is invoked with three arguments: (value, key, object).
Parameter object
The object to iterate over.
Parameter iteratee
The function invoked per iteration. Returns the new mapped object.
See Also
_.mapValues
interface LoDashStatic
interface LoDashStatic {}
method merge
merge: { <TObject, TSource>(object: TObject, source: TSource): TObject & TSource; <TObject, TSource1, TSource2>( object: TObject, source1: TSource1, source2: TSource2 ): TObject & TSource1 & TSource2; <TObject, TSource1, TSource2, TSource3>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3 ): TObject & TSource1 & TSource2 & TSource3; <TObject, TSource1, TSource2, TSource3, TSource4>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): TObject & TSource1 & TSource2 & TSource3 & TSource4; (object: any, ...otherArgs: any[]): any;};
Recursively merges own and inherited enumerable properties of source objects into the destination object, skipping source properties that resolve to
undefined
. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.**Note:** This method mutates
object
.Object
Parameter object
The destination object.
Parameter sources
The source objects.
Returns
Returns
object
.Example 1
var users = { 'data': [{ 'user': 'barney' }, { 'user': 'fred' }] };
var ages = { 'data': [{ 'age': 36 }, { 'age': 40 }] };
_.merge(users, ages); // => { 'data': [{ 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 40 }] }
See Also
_.merge
interface LoDashStatic
interface LoDashStatic {}
method mergeWith
mergeWith: { <TObject, TSource>( object: TObject, source: TSource, customizer: MergeWithCustomizer ): TObject & TSource; <TObject, TSource1, TSource2>( object: TObject, source1: TSource1, source2: TSource2, customizer: ( value: any, srcValue: any, key: string, object: any, source: any ) => any ): TObject & TSource1 & TSource2; <TObject, TSource1, TSource2, TSource3>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, customizer: ( value: any, srcValue: any, key: string, object: any, source: any ) => any ): TObject & TSource1 & TSource2 & TSource3; <TObject, TSource1, TSource2, TSource3, TSource4>( object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: ( value: any, srcValue: any, key: string, object: any, source: any ) => any ): TObject & TSource1 & TSource2 & TSource3 & TSource4; (object: any, ...otherArgs: any[]): any;};
This method is like
_.merge
except that it acceptscustomizer
which is invoked to produce the merged values of the destination and source properties. Ifcustomizer
returnsundefined
merging is handled by the method instead. Thecustomizer
is invoked with seven arguments: (objValue, srcValue, key, object, source, stack).Object
Parameter object
The destination object.
Parameter sources
The source objects.
Parameter customizer
The function to customize assigned values.
Returns
Returns
object
.Example 1
function customizer(objValue, srcValue) { if (_.isArray(objValue)) { return objValue.concat(srcValue); } }
var object = { 'fruits': ['apple'], 'vegetables': ['beet'] };
var other = { 'fruits': ['banana'], 'vegetables': ['carrot'] };
_.mergeWith(object, other, customizer); // => { 'fruits': ['apple', 'banana'], 'vegetables': ['beet', 'carrot'] }
See Also
_.mergeWith
interface LoDashStatic
interface LoDashStatic {}
method omit
omit: { <T extends object, K extends PropertyName[]>( object: T | null | undefined, ...paths: K ): Pick<T, Exclude<keyof T, K[number]>>; <T extends object, K extends keyof T>(object: T, ...paths: Many<K>[]): Omit< T, K >; <T extends object>( object: T, ...paths: Many<PropertyName>[] ): globalThis.Partial<T>;};
The opposite of
_.pick
; this method creates an object composed of the own and inherited enumerable properties ofobject
that are not omitted.Object
Parameter object
The source object.
Parameter paths
The property names to omit, specified individually or in arrays..
Returns
Returns the new object.
Example 1
var object = { 'a': 1, 'b': '2', 'c': 3 };
_.omit(object, ['a', 'c']); // => { 'b': '2' }
See Also
_.omit
interface LoDashStatic
interface LoDashStatic {}
method omitBy
omitBy: { <T>( object: Dictionary<T> | null | undefined, predicate?: ValueKeyIteratee<T> ): Dictionary<T>; <T>( object: NumericDictionary<T>, predicate?: ValueKeyIteratee<T> ): NumericDictionary<T>; <T extends object>( object: T, predicate: ValueKeyIteratee<T[keyof T]> ): globalThis.Partial<T>;};
The opposite of
_.pickBy
; this method creates an object composed of the own and inherited enumerable properties ofobject
thatpredicate
doesn't return truthy for.Object
Parameter object
The source object.
Parameter predicate
The function invoked per property.
Returns
Returns the new object.
Example 1
var object = { 'a': 1, 'b': '2', 'c': 3 };
_.omitBy(object, _.isNumber); // => { 'b': '2' }
See Also
_.omitBy
interface LoDashStatic
interface LoDashStatic {}
method pick
pick: { <T extends object, U extends keyof T>( object: T, ...props: Array<Many<U>> ): Pick<T, U>; <T>(object: T, ...props: Many<PropertyPath>[]): globalThis.Partial<T>;};
Creates an object composed of the picked
object
properties.Object
Parameter object
The source object.
Parameter props
The property names to pick, specified individually or in arrays.
Returns
Returns the new object.
Example 1
var object = { 'a': 1, 'b': '2', 'c': 3 };
_.pick(object, ['a', 'c']); // => { 'a': 1, 'c': 3 }
See Also
_.pick
interface LoDashStatic
interface LoDashStatic {}
method pickBy
pickBy: { <T, S extends T>( object: Dictionary<T> | null | undefined, predicate: ValueKeyIterateeTypeGuard<T, S> ): Dictionary<S>; <T, S extends T>( object: NumericDictionary<T>, predicate: ValueKeyIterateeTypeGuard<T, S> ): NumericDictionary<S>; <T>(object: Dictionary<T>, predicate?: ValueKeyIteratee<T>): Dictionary<T>; <T>( object: NumericDictionary<T>, predicate?: ValueKeyIteratee<T> ): NumericDictionary<T>; <T extends object>( object: T, predicate?: ValueKeyIteratee<T[keyof T]> ): globalThis.Partial<T>;};
Creates an object composed of the
object
propertiespredicate
returns truthy for. The predicate is invoked with two arguments: (value, key).Object
Parameter object
The source object.
Parameter predicate
The function invoked per property.
Returns
Returns the new object.
Example 1
var object = { 'a': 1, 'b': '2', 'c': 3 };
_.pickBy(object, _.isNumber); // => { 'a': 1, 'c': 3 }
See Also
_.pickBy
interface LoDashStatic
interface LoDashStatic {}
method result
result: <TResult>( object: any, path: PropertyPath, defaultValue?: TResult | ((...args: any[]) => TResult)) => TResult;
This method is like _.get except that if the resolved value is a function it’s invoked with the this binding of its parent object and its result is returned.
Parameter object
The object to query.
Parameter path
The path of the property to resolve.
Parameter defaultValue
The value returned if the resolved value is undefined. Returns the resolved value.
interface LoDashStatic
interface LoDashStatic {}
method set
set: { <T extends object>(object: T, path: PropertyPath, value: any): T; <TResult>(object: object, path: PropertyPath, value: any): TResult;};
Sets the value at path of object. If a portion of path doesn’t exist it’s created. Arrays are created for missing index properties while objects are created for all other missing properties. Use _.setWith to customize path creation.
Parameter object
The object to modify.
Parameter path
The path of the property to set.
Parameter value
The value to set. Returns object.
See Also
_.set
interface LoDashStatic
interface LoDashStatic {}
method setWith
setWith: { <T extends object>( object: T, path: PropertyPath, value: any, customizer?: SetWithCustomizer<T> ): T; <T extends object, TResult>( object: T, path: PropertyPath, value: any, customizer?: SetWithCustomizer<T> ): TResult;};
This method is like _.set except that it accepts customizer which is invoked to produce the objects of path. If customizer returns undefined path creation is handled by the method instead. The customizer is invoked with three arguments: (nsValue, key, nsObject).
Parameter object
The object to modify.
Parameter path
The path of the property to set.
Parameter value
The value to set.
Parameter customizer
The function to customize assigned values. Returns object.
See Also
_.setWith
interface LoDashStatic
interface LoDashStatic {}
method toPairs
toPairs: { <T>(object?: Dictionary<T> | NumericDictionary<T>): Array<[string, T]>; (object?: object): [string, any][];};
Creates an array of own enumerable key-value pairs for object.
Parameter object
The object to query. Returns the new array of key-value pairs.
See Also
_.toPairs
interface LoDashStatic
interface LoDashStatic {}
method toPairsIn
toPairsIn: { <T>(object?: Dictionary<T> | NumericDictionary<T>): Array<[string, T]>; (object?: object): [string, any][];};
Creates an array of own and inherited enumerable key-value pairs for object.
Parameter object
The object to query. Returns the new array of key-value pairs.
See Also
_.toPairsIn
interface LoDashStatic
interface LoDashStatic {}
method transform
transform: { <T, TResult>( object: readonly T[], iteratee: MemoVoidArrayIterator<T, TResult>, accumulator?: TResult ): TResult; <T, TResult>( object: Dictionary<T>, iteratee: MemoVoidDictionaryIterator<T, string, TResult>, accumulator?: TResult ): TResult; <T extends object, TResult>( object: T, iteratee: MemoVoidDictionaryIterator<T[keyof T], keyof T, TResult>, accumulator?: TResult ): TResult; (object: any[]): any[]; (object: object): Dictionary<any>;};
An alternative to _.reduce; this method transforms object to a new accumulator object which is the result of running each of its own enumerable properties through iteratee, with each invocation potentially mutating the accumulator object. The iteratee is invoked with four arguments: (accumulator, value, key, object). Iteratee functions may exit iteration early by explicitly returning false.
Parameter object
The object to iterate over.
Parameter iteratee
The function invoked per iteration.
Parameter accumulator
The custom accumulator value. Returns the accumulated value.
See Also
_.transform
interface LoDashStatic
interface LoDashStatic {}
method unset
unset: (object: any, path: PropertyPath) => boolean;
Removes the property at path of object.
Note: This method mutates object.
Parameter object
The object to modify.
Parameter path
The path of the property to unset. Returns true if the property is deleted, else false.
interface LoDashStatic
interface LoDashStatic {}
method update
update: ( object: object, path: PropertyPath, updater: (value: any) => any) => any;
This method is like _.set except that accepts updater to produce the value to set. Use _.updateWith to customize path creation. The updater is invoked with one argument: (value).
Parameter object
The object to modify.
Parameter path
The path of the property to set.
Parameter updater
The function to produce the updated value. Returns object.
interface LoDashStatic
interface LoDashStatic {}
method updateWith
updateWith: { <T extends object>( object: T, path: PropertyPath, updater: (oldValue: any) => any, customizer?: SetWithCustomizer<T> ): T; <T extends object, TResult>( object: T, path: PropertyPath, updater: (oldValue: any) => any, customizer?: SetWithCustomizer<T> ): TResult;};
This method is like
_.update
except that it acceptscustomizer
which is invoked to produce the objects ofpath
. Ifcustomizer
returnsundefined
path creation is handled by the method instead. Thecustomizer
is invoked with three arguments: (nsValue, key, nsObject).**Note:** This method mutates
object
.4.6.0 Object
Parameter object
The object to modify.
Parameter path
The path of the property to set.
Parameter updater
The function to produce the updated value.
Parameter customizer
The function to customize assigned values.
Returns
Returns
object
.Example 1
var object = {};
_.updateWith(object, '[0][1]', _.constant('a'), Object); // => { '0': { '1': 'a' } }
See Also
_.updateWith
interface LoDashStatic
interface LoDashStatic {}
method values
values: { <T>( object: Dictionary<T> | NumericDictionary<T> | List<T> | null | undefined ): T[]; <T extends object>(object: T): T[keyof T][]; (object: any): any[];};
Creates an array of the own enumerable property values of object.
Parameter object
The object to query. Returns an array of property values.
See Also
_.values
interface LoDashStatic
interface LoDashStatic {}
method valuesIn
valuesIn: { <T>( object: Dictionary<T> | NumericDictionary<T> | List<T> | null | undefined ): T[]; <T extends object>(object: T): T[keyof T][];};
Creates an array of the own and inherited enumerable property values of object.
Parameter object
The object to query. Returns the array of property values.
See Also
_.valuesIn
interface LoDashStatic
interface LoDashStatic {}
method chain
chain: { <TrapAny extends { __lodashAnyHack: any }>( value: TrapAny ): CollectionChain<any> & FunctionChain<any> & ObjectChain<any> & PrimitiveChain<any> & StringChain; <T extends null>(value: T): PrimitiveChain<T>; <T extends string>(value: T): StringChain<T>; (value: string): StringNullableChain; <T extends (...args: any[]) => any>(value: T): FunctionChain<T>; <T = any>(value: List<T>): CollectionChain<T>; <T extends object>(value: T): ObjectChain<T>; <T>(value: T): PrimitiveChain<T>;};
Creates a lodash object that wraps value with explicit method chaining enabled.
Parameter value
The value to wrap. Returns the new lodash wrapper instance.
See Also
_.chain
interface LoDashStatic
interface LoDashStatic {}
method tap
tap: <T>(value: T, interceptor: (value: T) => void) => T;
This method invokes interceptor and returns value. The interceptor is invoked with one argument; (value). The purpose of this method is to "tap into" a method chain in order to perform operations on intermediate results within the chain.
Parameter value
The value to provide to interceptor.
Parameter interceptor
The function to invoke. Returns value.
interface LoDashStatic
interface LoDashStatic {}
method thru
thru: <T, TResult>(value: T, interceptor: (value: T) => TResult) => TResult;
This method is like _.tap except that it returns the result of interceptor.
Parameter value
The value to provide to interceptor.
Parameter interceptor
The function to invoke. Returns the result of interceptor.
interface LoDashStatic
interface LoDashStatic {}
method camelCase
camelCase: (string?: string) => string;
Converts string to camel case.
Parameter string
The string to convert. Returns the camel cased string.
interface LoDashStatic
interface LoDashStatic {}
method capitalize
capitalize: <T extends string>(string?: T) => Capitalize<Lowercase<T>>;
Converts the first character of string to upper case and the remaining to lower case.
Parameter string
The string to capitalize. Returns the capitalized string.
interface LoDashStatic
interface LoDashStatic {}
method deburr
deburr: (string?: string) => string;
Deburrs string by converting latin-1 supplementary letters to basic latin letters and removing combining diacritical marks.
Parameter string
The string to deburr. Returns the deburred string.
interface LoDashStatic
interface LoDashStatic {}
method endsWith
endsWith: (string?: string, target?: string, position?: number) => boolean;
Checks if string ends with the given target string.
Parameter string
The string to search.
Parameter target
The string to search for.
Parameter position
The position to search from. Returns true if string ends with target, else false.
interface LoDashStatic
interface LoDashStatic {}
method escape
escape: (string?: string) => string;
Converts the characters "&", "<", ">", '"', "'", and "`" in string to their corresponding HTML entities.
Note: No other characters are escaped. To escape additional characters use a third-party library like he.
Though the ">" character is escaped for symmetry, characters like ">" and "/" don’t need escaping in HTML and have no special meaning unless they're part of a tag or unquoted attribute value. See Mathias Bynens’s article (under "semi-related fun fact") for more details.
Backticks are escaped because in IE < 9, they can break out of attribute values or HTML comments. See #59, #102, #108, and #133 of the HTML5 Security Cheatsheet for more details.
When working with HTML you should always quote attribute values to reduce XSS vectors.
Parameter string
The string to escape. Returns the escaped string.
interface LoDashStatic
interface LoDashStatic {}
method escapeRegExp
escapeRegExp: (string?: string) => string;
Escapes the RegExp special characters "^", "$", "", ".", "*", "+", "?", "(", ")", "[", "]", "{", "}", and "|" in string.
Parameter string
The string to escape. Returns the escaped string.
interface LoDashStatic
interface LoDashStatic {}
method kebabCase
kebabCase: (string?: string) => string;
Converts string to kebab case.
Parameter string
The string to convert. Returns the kebab cased string.
interface LoDashStatic
interface LoDashStatic {}
method lowerCase
lowerCase: (string?: string) => string;
Converts
string
, as space separated words, to lower case.Parameter string
The string to convert. Returns the lower cased string.
interface LoDashStatic
interface LoDashStatic {}
method lowerFirst
lowerFirst: <T extends string = string>(string?: T) => Uncapitalize<T>;
Converts the first character of
string
to lower case.Parameter string
The string to convert. Returns the converted string.
interface LoDashStatic
interface LoDashStatic {}
method pad
pad: (string?: string, length?: number, chars?: string) => string;
Pads string on the left and right sides if it’s shorter than length. Padding characters are truncated if they can’t be evenly divided by length.
Parameter string
The string to pad.
Parameter length
The padding length.
Parameter chars
The string used as padding. Returns the padded string.
interface LoDashStatic
interface LoDashStatic {}
method padEnd
padEnd: (string?: string, length?: number, chars?: string) => string;
Pads string on the right side if it’s shorter than length. Padding characters are truncated if they exceed length.
Parameter string
The string to pad.
Parameter length
The padding length.
Parameter chars
The string used as padding. Returns the padded string.
interface LoDashStatic
interface LoDashStatic {}
method padStart
padStart: (string?: string, length?: number, chars?: string) => string;
Pads string on the left side if it’s shorter than length. Padding characters are truncated if they exceed length.
Parameter string
The string to pad.
Parameter length
The padding length.
Parameter chars
The string used as padding. Returns the padded string.
interface LoDashStatic
interface LoDashStatic {}
method parseInt
parseInt: (string: string, radix?: number) => number;
Converts string to an integer of the specified radix. If radix is undefined or 0, a radix of 10 is used unless value is a hexadecimal, in which case a radix of 16 is used.
Note: This method aligns with the ES5 implementation of parseInt.
Parameter string
The string to convert.
Parameter radix
The radix to interpret value by. Returns the converted integer.
interface LoDashStatic
interface LoDashStatic {}
method repeat
repeat: (string?: string, n?: number) => string;
Repeats the given string n times.
Parameter string
The string to repeat.
Parameter n
The number of times to repeat the string. Returns the repeated string.
interface LoDashStatic
interface LoDashStatic {}
method replace
replace: { ( string: string, pattern: RegExp | string, replacement: ReplaceFunction | string ): string; (pattern: string | RegExp, replacement: string | ReplaceFunction): string;};
Replaces matches for pattern in string with replacement.
Note: This method is based on String#replace.
Returns the modified string.
See Also
_.replace
interface LoDashStatic
interface LoDashStatic {}
method snakeCase
snakeCase: (string?: string) => string;
Converts string to snake case.
Parameter string
The string to convert. Returns the snake cased string.
interface LoDashStatic
interface LoDashStatic {}
method split
split: { ( string: string | null | undefined, separator?: RegExp | string, limit?: number ): string[]; (string: string, index: string | number, guard: object): string[];};
Splits string by separator.
Note: This method is based on String#split.
Parameter string
The string to split.
Parameter separator
The separator pattern to split by.
Parameter limit
The length to truncate results to. Returns the new array of string segments.
See Also
_.split
interface LoDashStatic
interface LoDashStatic {}
method startCase
startCase: (string?: string) => string;
Converts string to start case.
Parameter string
The string to convert. Returns the start cased string.
interface LoDashStatic
interface LoDashStatic {}
method startsWith
startsWith: (string?: string, target?: string, position?: number) => boolean;
Checks if string starts with the given target string.
Parameter string
The string to search.
Parameter target
The string to search for.
Parameter position
The position to search from. Returns true if string starts with target, else false.
interface LoDashStatic
interface LoDashStatic {}
method template
template: (string?: string, options?: TemplateOptions) => TemplateExecutor;
Creates a compiled template function that can interpolate data properties in "interpolate" delimiters, HTML-escape interpolated data properties in "escape" delimiters, and execute JavaScript in "evaluate" delimiters. Data properties may be accessed as free variables in the template. If a setting object is provided it takes precedence over _.templateSettings values.
Note: In the development build _.template utilizes [sourceURLs](http://www.html5rocks.com/en/tutorials/developertools/sourcemaps/#toc-sourceurl) for easier debugging.
For more information on precompiling templates see [lodash's custom builds documentation](https://lodash.com/custom-builds).
For more information on Chrome extension sandboxes see [Chrome's extensions documentation](https://developer.chrome.com/extensions/sandboxingEval).
Parameter string
The template string.
Parameter options
The options object.
Parameter
options.escape The HTML "escape" delimiter.
Parameter
options.evaluate The "evaluate" delimiter.
Parameter
options.imports An object to import into the template as free variables.
Parameter
options.interpolate The "interpolate" delimiter.
Parameter
options.sourceURL The sourceURL of the template's compiled source.
Parameter
options.variable The data object variable name. Returns the compiled template function.
interface LoDashStatic
interface LoDashStatic {}
method toLower
toLower: <T extends string = string>(string?: T) => Lowercase<T>;
Converts
string
, as a whole, to lower case.Parameter string
The string to convert. Returns the lower cased string.
interface LoDashStatic
interface LoDashStatic {}
method toUpper
toUpper: <T extends string = string>(string?: T) => Uppercase<T>;
Converts
string
, as a whole, to upper case.Parameter string
The string to convert. Returns the upper cased string.
interface LoDashStatic
interface LoDashStatic {}
method trim
trim: { (string?: string, chars?: string): string; (string: string, index: string | number, guard: object): string;};
Removes leading and trailing whitespace or specified characters from string.
Parameter string
The string to trim.
Parameter chars
The characters to trim. Returns the trimmed string.
See Also
_.trim
interface LoDashStatic
interface LoDashStatic {}
method trimEnd
trimEnd: { (string?: string, chars?: string): string; (string: string, index: string | number, guard: object): string;};
Removes trailing whitespace or specified characters from string.
Parameter string
The string to trim.
Parameter chars
The characters to trim. Returns the trimmed string.
See Also
_.trimEnd
interface LoDashStatic
interface LoDashStatic {}
method trimStart
trimStart: { (string?: string, chars?: string): string; (string: string, index: string | number, guard: object): string;};
Removes leading whitespace or specified characters from string.
Parameter string
The string to trim.
Parameter chars
The characters to trim. Returns the trimmed string.
See Also
_.trimStart
interface LoDashStatic
interface LoDashStatic {}
method truncate
truncate: (string?: string, options?: TruncateOptions) => string;
Truncates string if it’s longer than the given maximum string length. The last characters of the truncated string are replaced with the omission string which defaults to "…".
Parameter string
The string to truncate.
Parameter options
The options object or maximum string length. Returns the truncated string.
interface LoDashStatic
interface LoDashStatic {}
method unescape
unescape: (string?: string) => string;
The inverse of _.escape; this method converts the HTML entities &, <, >, ", ', and ` in string to their corresponding characters.
Note: No other HTML entities are unescaped. To unescape additional HTML entities use a third-party library like he.
Parameter string
The string to unescape. Returns the unescaped string.
interface LoDashStatic
interface LoDashStatic {}
method upperCase
upperCase: (string?: string) => string;
Converts
string
, as space separated words, to upper case.Parameter string
The string to convert. Returns the upper cased string.
interface LoDashStatic
interface LoDashStatic {}
method upperFirst
upperFirst: <T extends string = string>(string?: T) => Capitalize<T>;
Converts the first character of
string
to upper case.Parameter string
The string to convert. Returns the converted string.
interface LoDashStatic
interface LoDashStatic {}
method words
words: { (string?: string, pattern?: string | RegExp): string[]; (string: string, index: string | number, guard: object): string[];};
Splits
string
into an array of its words.Parameter string
The string to inspect.
Parameter pattern
The pattern to match words. Returns the words of
string
.See Also
_.words
interface LoDashStatic
interface LoDashStatic {}
method attempt
attempt: <TResult>( func: (...args: any[]) => TResult, ...args: any[]) => TResult | Error;
Attempts to invoke func, returning either the result or the caught error object. Any additional arguments are provided to func when it’s invoked.
Parameter func
The function to attempt. Returns the func result or error object.
interface LoDashStatic
interface LoDashStatic {}
method bindAll
bindAll: <T>(object: T, ...methodNames: Array<Many<string>>) => T;
Binds methods of an object to the object itself, overwriting the existing method. Method names may be specified as individual arguments or as arrays of method names. If no method names are provided all enumerable function properties, own and inherited, of object are bound.
Note: This method does not set the "length" property of bound functions.
Parameter object
The object to bind and assign the bound methods to.
Parameter methodNames
The object method names to bind, specified as individual method names or arrays of method names. Returns object.
interface LoDashStatic
interface LoDashStatic {}
method cond
cond: { <R>(pairs: Array<CondPairNullary<R>>): () => R; <T, R>(pairs: CondPairUnary<T, R>[]): (Target: T) => R;};
Creates a function that iterates over
pairs
and invokes the corresponding function of the first predicate to return truthy. The predicate-function pairs are invoked with thethis
binding and arguments of the created function.4.0.0 Util
Parameter pairs
The predicate-function pairs.
Returns
Returns the new composite function.
Example 1
var func = _.cond([ [_.matches({ 'a': 1 }), _.constant('matches A')], [_.conforms({ 'b': _.isNumber }), _.constant('matches B')], [_.stubTrue, _.constant('no match')] ]);
func({ 'a': 1, 'b': 2 }); // => 'matches A'
func({ 'a': 0, 'b': 1 }); // => 'matches B'
func({ 'a': '1', 'b': '2' }); // => 'no match'
interface LoDashStatic
interface LoDashStatic {}
method conforms
conforms: <T>(source: ConformsPredicateObject<T>) => (value: T) => boolean;
Creates a function that invokes the predicate properties of
source
with the corresponding property values of a given object, returning true if all predicates return truthy, else false.
interface LoDashStatic
interface LoDashStatic {}
method constant
constant: <T>(value: T) => () => T;
Creates a function that returns value.
Parameter value
The value to return from the new function. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method defaultTo
defaultTo: { <T>(value: T | null | undefined, defaultValue: T): T; <T, TDefault>(value: T, defaultValue: TDefault): T | TDefault;};
Checks
value
to determine whether a default value should be returned in its place. ThedefaultValue
is returned ifvalue
isNaN
,null
, orundefined
.Parameter value
The value to check.
Parameter defaultValue
The default value.
Returns
Returns the resolved value.
See Also
_.defaultTo
interface LoDashStatic
interface LoDashStatic {}
method flow
flow: { <A extends any[], R1, R2, R3, R4, R5, R6, R7>( f1: (...args: A) => R1, f2: (a: R1) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5, f6: (a: R5) => R6, f7: (a: R6) => R7 ): (...args: A) => R7; <A extends any[], R1, R2, R3, R4, R5, R6, R7>( f1: (...args: A) => R1, f2: (a: R1) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5, f6: (a: R5) => R6, f7: (a: R6) => R7, ...func: Many<(a: any) => any>[] ): (...args: A) => any; <A extends any[], R1, R2, R3, R4, R5, R6>( f1: (...args: A) => R1, f2: (a: R1) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5, f6: (a: R5) => R6 ): (...args: A) => R6; <A extends any[], R1, R2, R3, R4, R5>( f1: (...args: A) => R1, f2: (a: R1) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4, f5: (a: R4) => R5 ): (...args: A) => R5; <A extends any[], R1, R2, R3, R4>( f1: (...args: A) => R1, f2: (a: R1) => R2, f3: (a: R2) => R3, f4: (a: R3) => R4 ): (...args: A) => R4; <A extends any[], R1, R2, R3>( f1: (...args: A) => R1, f2: (a: R1) => R2, f3: (a: R2) => R3 ): (...args: A) => R3; <A extends any[], R1, R2>(f1: (...args: A) => R1, f2: (a: R1) => R2): ( ...args: A ) => R2; (...func: Many<(...args: any[]) => any>[]): (...args: any[]) => any;};
Creates a function that returns the result of invoking the provided functions with the this binding of the created function, where each successive invocation is supplied the return value of the previous.
Parameter funcs
Functions to invoke. Returns the new function.
See Also
_.flow
interface LoDashStatic
interface LoDashStatic {}
method flowRight
flowRight: { <A extends any[], R1, R2, R3, R4, R5, R6, R7>( f7: (a: R6) => R7, f6: (a: R5) => R6, f5: (a: R4) => R5, f4: (a: R3) => R4, f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): (...args: A) => R7; <A extends any[], R1, R2, R3, R4, R5, R6>( f6: (a: R5) => R6, f5: (a: R4) => R5, f4: (a: R3) => R4, f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): (...args: A) => R6; <A extends any[], R1, R2, R3, R4, R5>( f5: (a: R4) => R5, f4: (a: R3) => R4, f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): (...args: A) => R5; <A extends any[], R1, R2, R3, R4>( f4: (a: R3) => R4, f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): (...args: A) => R4; <A extends any[], R1, R2, R3>( f3: (a: R2) => R3, f2: (a: R1) => R2, f1: (...args: A) => R1 ): (...args: A) => R3; <A extends any[], R1, R2>(f2: (a: R1) => R2, f1: (...args: A) => R1): ( ...args: A ) => R2; (...func: Many<(...args: any[]) => any>[]): (...args: any[]) => any;};
This method is like _.flow except that it creates a function that invokes the provided functions from right to left.
Parameter funcs
Functions to invoke. Returns the new function.
See Also
_.flowRight
interface LoDashStatic
interface LoDashStatic {}
method identity
identity: { <T>(value: T): T; (): undefined };
This method returns the first argument provided to it.
Parameter value
Any value. Returns value.
See Also
_.identity
interface LoDashStatic
interface LoDashStatic {}
method iteratee
iteratee: { <TFunction extends (...args: any[]) => any>(func: TFunction): TFunction; (func: string | number | symbol | object): (...args: any[]) => any;};
Creates a function that invokes
func
with the arguments of the created function. Iffunc
is a property name the created callback returns the property value for a given element. Iffunc
is an object the created callback returnstrue
for elements that contain the equivalent object properties, otherwise it returnsfalse
.Util
Parameter func
The value to convert to a callback.
Returns
Returns the callback.
Example 1
var users = [ { 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 40 } ];
// create custom iteratee shorthands _.iteratee = _.wrap(_.iteratee, function(callback, func) { var p = /^(\S+)\s*([<>])\s*(\S+)$/.exec(func); return !p ? callback(func) : function(object) { return (p[2] == '>' ? object[p[1]] > p[3] : object[p[1]] < p[3]); }; });
_.filter(users, 'age > 36'); // => [{ 'user': 'fred', 'age': 40 }]
See Also
_.iteratee
interface LoDashStatic
interface LoDashStatic {}
method matches
matches: { <T>(source: T): (value: any) => boolean; <T, V>(source: T): (value: V) => boolean;};
Creates a function that performs a deep comparison between a given object and source, returning true if the given object has equivalent property values, else false.
Note: This method supports comparing arrays, booleans, Date objects, numbers, Object objects, regexes, and strings. Objects are compared by their own, not inherited, enumerable properties. For comparing a single own or inherited property value see _.matchesProperty.
Parameter source
The object of property values to match. Returns the new function.
See Also
_.matches
interface LoDashStatic
interface LoDashStatic {}
method matchesProperty
matchesProperty: { <T>(path: PropertyPath, srcValue: T): (value: any) => boolean; <T, V>(path: PropertyPath, srcValue: T): (value: V) => boolean;};
Creates a function that compares the property value of path on a given object to value.
Note: This method supports comparing arrays, booleans, Date objects, numbers, Object objects, regexes, and strings. Objects are compared by their own, not inherited, enumerable properties.
Parameter path
The path of the property to get.
Parameter srcValue
The value to match. Returns the new function.
See Also
_.matchesProperty
interface LoDashStatic
interface LoDashStatic {}
method method
method: (path: PropertyPath, ...args: any[]) => (object: any) => any;
Creates a function that invokes the method at path on a given object. Any additional arguments are provided to the invoked method.
Parameter path
The path of the method to invoke.
Parameter args
The arguments to invoke the method with. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method methodOf
methodOf: (object: object, ...args: any[]) => (path: PropertyPath) => any;
The opposite of _.method; this method creates a function that invokes the method at a given path on object. Any additional arguments are provided to the invoked method.
Parameter object
The object to query.
Parameter args
The arguments to invoke the method with. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method mixin
mixin: { <TObject>( object: TObject, source: Dictionary<(...args: any[]) => any>, options?: MixinOptions ): TObject; <TResult>( source: Dictionary<(...args: any[]) => any>, options?: MixinOptions ): LoDashStatic;};
Adds all own enumerable function properties of a source object to the destination object. If object is a function then methods are added to its prototype as well.
Note: Use _.runInContext to create a pristine lodash function to avoid conflicts caused by modifying the original.
Parameter object
The destination object.
Parameter source
The object of functions to add.
Parameter options
The options object.
Parameter
options.chain Specify whether the functions added are chainable. Returns object.
See Also
_.mixin
interface LoDashStatic
interface LoDashStatic {}
method noConflict
noConflict: () => typeof _;
Reverts the _ variable to its previous value and returns a reference to the lodash function.
Returns the lodash function.
interface LoDashStatic
interface LoDashStatic {}
method noop
noop: (...args: any[]) => void;
A no-operation function that returns undefined regardless of the arguments it receives.
undefined
interface LoDashStatic
interface LoDashStatic {}
method nthArg
nthArg: (n?: number) => (...args: any[]) => any;
Creates a function that returns its nth argument.
Parameter n
The index of the argument to return. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method over
over: <TResult>( ...iteratees: Many<(...args: any[]) => TResult>[]) => (...args: any[]) => TResult[];
Creates a function that invokes iteratees with the arguments provided to the created function and returns their results.
Parameter iteratees
The iteratees to invoke. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method overEvery
overEvery: { <T, Result1 extends T, Result2 extends T>( predicates_0: (arg: T) => arg is Result1, predicates_1: (arg: T) => arg is Result2 ): (arg: T) => arg is Result1 & Result2; <T>(...predicates: Many<(...args: T[]) => boolean>[]): ( ...args: T[] ) => boolean;};
Creates a function that checks if all of the predicates return truthy when invoked with the arguments provided to the created function.
Parameter predicates
The predicates to check. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method overSome
overSome: { <T, Result1 extends T, Result2 extends T>( predicates_0: (arg: T) => arg is Result1, predicates_1: (arg: T) => arg is Result2 ): (arg: T) => arg is Result1 | Result2; <T>(...predicates: Many<(...args: T[]) => boolean>[]): ( ...args: T[] ) => boolean;};
Creates a function that checks if any of the predicates return truthy when invoked with the arguments provided to the created function.
Parameter predicates
The predicates to check. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method property
property: <TObj, TResult>(path: PropertyPath) => (obj: TObj) => TResult;
Creates a function that returns the property value at path on a given object.
Parameter path
The path of the property to get. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method propertyOf
propertyOf: <T extends {}>(object: T) => (path: PropertyPath) => any;
The opposite of _.property; this method creates a function that returns the property value at a given path on object.
Parameter object
The object to query. Returns the new function.
interface LoDashStatic
interface LoDashStatic {}
method range
range: { (start: number, end?: number, step?: number): number[]; (end: number, index: string | number, guard: object): number[];};
Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end. If end is not specified it’s set to start with start then set to 0. If end is less than start a zero-length range is created unless a negative step is specified.
Parameter start
The start of the range.
Parameter end
The end of the range.
Parameter step
The value to increment or decrement by. Returns a new range array.
See Also
_.range
interface LoDashStatic
interface LoDashStatic {}
method rangeRight
rangeRight: { (start: number, end?: number, step?: number): number[]; (end: number, index: string | number, guard: object): number[];};
This method is like
_.range
except that it populates values in descending order.Util
Parameter start
The start of the range.
Parameter end
The end of the range.
Parameter step
The value to increment or decrement by.
Returns
Returns the new array of numbers.
Example 1
_.rangeRight(4); // => [3, 2, 1, 0]
_.rangeRight(-4); // => [-3, -2, -1, 0]
_.rangeRight(1, 5); // => [4, 3, 2, 1]
_.rangeRight(0, 20, 5); // => [15, 10, 5, 0]
_.rangeRight(0, -4, -1); // => [-3, -2, -1, 0]
_.rangeRight(1, 4, 0); // => [1, 1, 1]
_.rangeRight(0); // => []
See Also
_.rangeRight
interface LoDashStatic
interface LoDashStatic {}
method runInContext
runInContext: (context?: object) => LoDashStatic;
Create a new pristine lodash function using the given context object.
Parameter context
The context object. Returns a new lodash function.
interface LoDashStatic
interface LoDashStatic {}
method stubArray
stubArray: () => any[];
This method returns a new empty array.
Returns
Returns the new empty array.
interface LoDashStatic
interface LoDashStatic {}
method stubFalse
stubFalse: { (): false; (): false };
This method returns
false
.Returns
Returns
false
.
interface LoDashStatic
interface LoDashStatic {}
method stubObject
stubObject: () => any;
This method returns a new empty object.
Returns
Returns the new empty object.
interface LoDashStatic
interface LoDashStatic {}
method stubString
stubString: () => string;
This method returns an empty string.
Returns
Returns the empty string.
interface LoDashStatic
interface LoDashStatic {}
method stubTrue
stubTrue: { (): true; (): true };
This method returns
true
.Returns
Returns
true
.
interface LoDashStatic
interface LoDashStatic {}
method times
times: { <TResult>(n: number, iteratee: (num: number) => TResult): TResult[]; (n: number): number[];};
Invokes the iteratee function n times, returning an array of the results of each invocation. The iteratee is invoked with one argument; (index).
Parameter n
The number of times to invoke iteratee.
Parameter iteratee
The function invoked per iteration. Returns the array of results.
See Also
_.times
interface LoDashStatic
interface LoDashStatic {}
method toPath
toPath: (value: any) => string[];
Converts
value
to a property path array.Util
Parameter value
The value to convert.
Returns
Returns the new property path array.
Example 1
_.toPath('a.b.c'); // => ['a', 'b', 'c']
_.toPath('a[0].b.c'); // => ['a', '0', 'b', 'c']
var path = ['a', 'b', 'c'], newPath = _.toPath(path);
console.log(newPath); // => ['a', 'b', 'c']
console.log(path === newPath); // => false
interface LoDashStatic
interface LoDashStatic {}
method uniqueId
uniqueId: (prefix?: string) => string;
Generates a unique ID. If prefix is provided the ID is appended to it.
Parameter prefix
The value to prefix the ID with. Returns the unique ID.
interface LoDashStatic
interface LoDashStatic {}
method stubTrue
stubTrue: { (): true; (): true };
This method returns true.
Returns true.
interface LoDashStatic
interface LoDashStatic {}
method stubFalse
stubFalse: { (): false; (): false };
This method returns false.
Returns false.
interface LoDashWrapper
interface LoDashWrapper<TValue> {}
method toString
toString: () => string;
See Also
_.toString
interface MapCache
interface MapCache {}
Creates a cache object to store key/value pairs.
property clear
clear?: (() => void) | undefined;
Removes all key-value entries from the map.
method delete
delete: (key: any) => boolean;
Removes
key
and its value from the cache.Parameter key
The key of the value to remove. Returns
true
if the entry was removed successfully, elsefalse
.
method get
get: (key: any) => any;
Gets the cached value for
key
.Parameter key
The key of the value to get. Returns the cached value.
method has
has: (key: any) => boolean;
Checks if a cached value for
key
exists.Parameter key
The key of the entry to check. Returns
true
if an entry forkey
exists, elsefalse
.
method set
set: (key: any, value: any) => this;
Sets
value
tokey
of the cache.Parameter key
The key of the value to cache.
Parameter value
The value to cache. Returns the cache object.
interface MapCacheConstructor
interface MapCacheConstructor {}
construct signature
new (): MapCache;
interface MemoizedFunction
interface MemoizedFunction {}
property cache
cache: MapCache;
See Also
_.cache
interface MixinOptions
interface MixinOptions {}
property chain
chain?: boolean | undefined;
See Also
_.chain
interface NumericDictionary
interface NumericDictionary<T> {}
index signature
[index: number]: T;
interface Object
interface Object<T> extends LoDashImplicitWrapper<T> {}
interface Object
interface Object<T> {}
method concat
concat: (...values: Array<Many<T>>) => Collection<T>;
See Also
_.concat
interface Object
interface Object<T> {}
method countBy
countBy: (iteratee?: ValueIteratee<T[keyof T]>) => Object<Dictionary<number>>;
See Also
_.countBy
interface Object
interface Object<T> {}
property eachRight
eachRight: Object<T>['forEachRight'];
See Also
_.eachRight
interface Object
interface Object<T> {}
method every
every: (predicate?: ObjectIterateeCustom<T, boolean>) => boolean;
See Also
_.every
interface Object
interface Object<T> {}
method filter
filter: { <S extends T[keyof T]>( predicate: ObjectIteratorTypeGuard<T, S> ): Collection<S>; (predicate?: ObjectIterateeCustom<T, boolean>): Collection<T[keyof T]>;};
See Also
_.filter
interface Object
interface Object<T> {}
method find
find: { <S extends T[keyof T]>( predicate: ObjectIteratorTypeGuard<T, S>, fromIndex?: number ): S | undefined; ( predicate?: ObjectIterateeCustom<T, boolean>, fromIndex?: number ): T[keyof T];};
See Also
_.find
interface Object
interface Object<T> {}
method findLast
findLast: { <S extends T[keyof T]>( predicate: ObjectIteratorTypeGuard<T, S>, fromIndex?: number ): S | undefined; ( predicate?: ObjectIterateeCustom<T, boolean>, fromIndex?: number ): T[keyof T];};
See Also
_.findLast
interface Object
interface Object<T> {}
method flatMap
flatMap: { <TResult = any>( iteratee: ObjectIterator<T, Many<TResult>> | PropertyName ): Collection<TResult>; (iteratee: object | [PropertyName, any]): Collection<boolean>; (): Collection<T[keyof T]>;};
See Also
_.flatMap
interface Object
interface Object<T> {}
method flatMapDeep
flatMapDeep: { <TResult = any>( iteratee: | ObjectIterator<T, ListOfRecursiveArraysOrValues<TResult> | TResult> | PropertyName ): Collection<TResult>; (iteratee: object | [PropertyName, any]): Collection<boolean>; (): Collection<T[keyof T]>;};
See Also
_.flatMapDeep
interface Object
interface Object<T> {}
method flatMapDepth
flatMapDepth: { <TResult = any>( iteratee: | ObjectIterator<T, ListOfRecursiveArraysOrValues<TResult> | TResult> | PropertyName, depth?: number ): Collection<TResult>; ( iteratee: object | [PropertyName, any], depth?: number ): Collection<boolean>; (depth?: number): Collection<T[keyof T]>;};
See Also
_.flatMapDepth
interface Object
interface Object<T> {}
method forEach
forEach: (iteratee?: ObjectIterator<T, any>) => Object<T>;
See Also
_.forEach
interface Object
interface Object<T> {}
method forEachRight
forEachRight: (iteratee?: ObjectIterator<T, any>) => Object<T>;
See Also
_.forEachRight
interface Object
interface Object<T> {}
method groupBy
groupBy: ( iteratee?: ValueIteratee<T[keyof T]>) => Object<Dictionary<Array<T[keyof T]>>>;
See Also
_.groupBy
interface Object
interface Object<T> {}
method includes
includes: (target: T[keyof T], fromIndex?: number) => boolean;
See Also
_.includes
interface Object
interface Object<T> {}
method keyBy
keyBy: ( iteratee?: ValueIterateeCustom<T[keyof T], PropertyName>) => Object<Dictionary<T[keyof T]>>;
See Also
_.keyBy
interface Object
interface Object<T> {}
method map
map: { <K extends keyof T[keyof T]>(key: K): Collection<T[keyof T][K]>; <TResult>(iteratee: ObjectIterator<T, TResult>): Collection<TResult>; (iteratee: PropertyName): Collection<any>; (iteratee: object | [PropertyName, any]): Collection<boolean>; (): Collection<T[keyof T]>;};
See Also
_.map
interface Object
interface Object<T> {}
method orderBy
orderBy: ( iteratees?: Many<ObjectIterator<T, NotVoid>>, orders?: Many<boolean | 'asc' | 'desc'>) => Collection<T[keyof T]>;
See Also
_.orderBy
interface Object
interface Object<T> {}
method partition
partition: ( callback: ValueIteratee<T[keyof T]>) => LoDashImplicitWrapper<[Array<T[keyof T]>, Array<T[keyof T]>]>;
See Also
_.partition
interface Object
interface Object<T> {}
method reduce
reduce: { <TResult>( callback: MemoObjectIterator<T[keyof T], TResult, T>, accumulator: TResult ): TResult; (callback: MemoObjectIterator<T[keyof T], T[keyof T], T>): T[keyof T];};
See Also
_.reduce
interface Object
interface Object<T> {}
method reduceRight
reduceRight: { <TResult>( callback: MemoObjectIterator<T[keyof T], TResult, T>, accumulator: TResult ): TResult; (callback: MemoObjectIterator<T[keyof T], T[keyof T], T>): T[keyof T];};
See Also
_.reduceRight
interface Object
interface Object<T> {}
method reject
reject: (predicate?: ObjectIterateeCustom<T, boolean>) => Collection<T[keyof T]>;
See Also
_.reject
interface Object
interface Object<T> {}
method sample
sample: () => T[keyof T] | undefined;
See Also
_.sample
interface Object
interface Object<T> {}
method sampleSize
sampleSize: (n?: number) => Collection<T[keyof T]>;
See Also
_.sampleSize
interface Object
interface Object<T> {}
method shuffle
shuffle: () => Collection<T[keyof T]>;
See Also
_.shuffle
interface Object
interface Object<T> {}
method some
some: (predicate?: ObjectIterateeCustom<T, boolean>) => boolean;
See Also
_.some
interface Object
interface Object<T> {}
method sortBy
sortBy: (...iteratees: Array<Many<ObjectIteratee<T>>>) => Collection<T[keyof T]>;
See Also
_.sortBy
interface Object
interface Object<T> {}
method castArray
castArray: () => Collection<T>;
See Also
_.castArray
interface Object
interface Object<T> {}
method toArray
toArray: () => Collection<T[keyof T]>;
See Also
_.toArray
interface Object
interface Object<T> {}
method assign
assign: { <TSource>(source: TSource): Object<T & TSource>; <TSource1, TSource2>(source1: TSource1, source2: TSource2): Object< T & TSource1 & TSource2 >; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3 ): Object<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): Object<T & TSource1 & TSource2 & TSource3 & TSource4>; (): Object<T>; (...otherArgs: any[]): Object<any>;};
See Also
_.assign
interface Object
interface Object<T> {}
method assignIn
assignIn: { <TSource>(source: TSource): Object<T & TSource>; <TSource1, TSource2>(source1: TSource1, source2: TSource2): Object< T & TSource1 & TSource2 >; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3 ): Object<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): Object<T & TSource1 & TSource2 & TSource3 & TSource4>; (): Object<T>; <TResult>(...otherArgs: any[]): Object<TResult>;};
See Also
_.assignIn
interface Object
interface Object<T> {}
method assignInWith
assignInWith: { <TSource>(source: TSource, customizer: AssignCustomizer): Object< T & TSource >; <TSource1, TSource2>( source1: TSource1, source2: TSource2, customizer: AssignCustomizer ): Object<T & TSource1 & TSource2>; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer ): Object<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer ): Object<T & TSource1 & TSource2 & TSource3 & TSource4>; (): Object<T>; <TResult>(...otherArgs: any[]): Object<TResult>;};
See Also
_.assignInWith
interface Object
interface Object<T> {}
method assignWith
assignWith: { <TSource>(source: TSource, customizer: AssignCustomizer): Object< T & TSource >; <TSource1, TSource2>( source1: TSource1, source2: TSource2, customizer: AssignCustomizer ): Object<T & TSource1 & TSource2>; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer ): Object<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer ): Object<T & TSource1 & TSource2 & TSource3 & TSource4>; (): Object<T>; <TResult>(...otherArgs: any[]): Object<TResult>;};
See Also
_.assignWith
interface Object
interface Object<T> {}
method at
at: (...props: Array<Many<keyof T>>) => Collection<T[keyof T]>;
See Also
_.at
interface Object
interface Object<T> {}
method create
create: <U extends object>(properties?: U) => Object<T & U>;
See Also
_.create
interface Object
interface Object<T> {}
method defaults
defaults: { <TSource>(source: TSource): Object<NonNullable<TSource & T>>; <TSource1, TSource2>(source1: TSource1, source2: TSource2): Object< NonNullable<TSource2 & TSource1 & T> >; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3 ): Object<NonNullable<TSource3 & TSource2 & TSource1 & T>>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): Object<NonNullable<TSource4 & TSource3 & TSource2 & TSource1 & T>>; (): Object<NonNullable<T>>; (...sources: any[]): Object<any>;};
See Also
_.defaults
interface Object
interface Object<T> {}
method defaultsDeep
defaultsDeep: (...sources: any[]) => Object<any>;
See Also
_.defaultsDeep
interface Object
interface Object<T> {}
method entries
entries: () => Collection<[string, T[keyof T]]>;
See Also
_.entries
interface Object
interface Object<T> {}
method entriesIn
entriesIn: () => Collection<[string, T[keyof T]]>;
See Also
_.entriesIn
interface Object
interface Object<T> {}
method extend
extend: { <TSource>(source: TSource): Object<T & TSource>; <TSource1, TSource2>(source1: TSource1, source2: TSource2): Object< T & TSource1 & TSource2 >; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3 ): Object<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): Object<T & TSource1 & TSource2 & TSource3 & TSource4>; (): Object<T>; (...otherArgs: any[]): Object<any>;};
See Also
_.extend
interface Object
interface Object<T> {}
method extendWith
extendWith: { <TSource>(source: TSource, customizer: AssignCustomizer): Object< T & TSource >; <TSource1, TSource2>( source1: TSource1, source2: TSource2, customizer: AssignCustomizer ): Object<T & TSource1 & TSource2>; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer ): Object<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer ): Object<T & TSource1 & TSource2 & TSource3 & TSource4>; (): Object<T>; (...otherArgs: any[]): Object<any>;};
See Also
_.extendWith
interface Object
interface Object<T> {}
method get
get: { <TKey extends keyof T>(path: TKey | [TKey]): T[TKey]; <TKey extends keyof T, TDefault>( path: TKey | [TKey], defaultValue: TDefault ): TDefault | Exclude<T[TKey], undefined>; <TKey1 extends keyof T, TKey2 extends keyof T[TKey1]>( path: [TKey1, TKey2] ): T[TKey1][TKey2]; <TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TDefault>( path: [TKey1, TKey2], defaultValue: TDefault ): TDefault | Exclude<T[TKey1][TKey2], undefined>; < TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TKey3 extends keyof T[TKey1][TKey2] >( path: [TKey1, TKey2, TKey3] ): T[TKey1][TKey2][TKey3]; < TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TKey3 extends keyof T[TKey1][TKey2], TDefault >( path: [TKey1, TKey2, TKey3], defaultValue: TDefault ): TDefault | Exclude<T[TKey1][TKey2][TKey3], undefined>; < TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TKey3 extends keyof T[TKey1][TKey2], TKey4 extends keyof T[TKey1][TKey2][TKey3] >( path: [TKey1, TKey2, TKey3, TKey4] ): T[TKey1][TKey2][TKey3][TKey4]; < TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TKey3 extends keyof T[TKey1][TKey2], TKey4 extends keyof T[TKey1][TKey2][TKey3], TDefault >( path: [TKey1, TKey2, TKey3, TKey4], defaultValue: TDefault ): TDefault | Exclude<T[TKey1][TKey2][TKey3][TKey4], undefined>; <TPath extends string>(path: TPath): string extends TPath ? any : GetFieldType<T, TPath, 'Path'>; <TPath extends string, TDefault = GetFieldType<T, TPath, 'Path'>>( path: TPath, defaultValue: TDefault ): TDefault | Exclude<GetFieldType<T, TPath, 'Path'>, null>; (path: PropertyPath, defaultValue?: any): any;};
See Also
_.get
interface Object
interface Object<T> {}
method invertBy
invertBy: (iteratee?: ValueIteratee<T[keyof T]>) => Object<Dictionary<string[]>>;
See Also
_.invertBy
interface Object
interface Object<T> {}
method mapKeys
mapKeys: (iteratee?: ObjectIteratee<T>) => Object<Dictionary<T[keyof T]>>;
See Also
_.mapKeys
interface Object
interface Object<T> {}
method mapValues
mapValues: { <TResult>(callback: ObjectIterator<T, TResult>): Object<{ [P in keyof T]: TResult; }>; <TResult>(callback: DictionaryIterator<T[keyof T], TResult>): Object< Dictionary<TResult> >; (iteratee: object): Object<{ [P in keyof T]: boolean }>; <TKey extends keyof T[keyof T]>(iteratee: TKey): Object< Dictionary<T[keyof T][TKey]> >; (iteratee: string): Object<{ [P in keyof T]: any }>; (): Object<T>;};
See Also
_.mapValues
interface Object
interface Object<T> {}
method merge
merge: { <TSource>(source: TSource): Object<T & TSource>; <TSource1, TSource2>(source1: TSource1, source2: TSource2): Object< T & TSource1 & TSource2 >; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3 ): Object<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): Object<T & TSource1 & TSource2 & TSource3 & TSource4>; (...otherArgs: any[]): Object<any>;};
See Also
_.merge
interface Object
interface Object<T> {}
method mergeWith
mergeWith: { <TSource>(source: TSource, customizer: MergeWithCustomizer): Object< T & TSource >; <TSource1, TSource2>( source1: TSource1, source2: TSource2, customizer: ( value: any, srcValue: any, key: string, object: any, source: any ) => any ): Object<T & TSource1 & TSource2>; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3, customizer: ( value: any, srcValue: any, key: string, object: any, source: any ) => any ): Object<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: ( value: any, srcValue: any, key: string, object: any, source: any ) => any ): Object<T & TSource1 & TSource2 & TSource3 & TSource4>; (...otherArgs: any[]): Object<any>;};
See Also
_.mergeWith
interface Object
interface Object<T> {}
method omit
omit: { <K extends keyof T>(...paths: Array<Many<K>>): Object<Omit<T, K>>; ( ...paths: Many< string | number | symbol | [PropertyName, any] | PartialShallow<T> >[] ): Object<globalThis.Partial<T>>;};
See Also
_.omit
interface Object
interface Object<T> {}
method omitBy
omitBy: (predicate: ValueKeyIteratee<T[keyof T]>) => Object<PartialObject<T>>;
See Also
_.omitBy
interface Object
interface Object<T> {}
method pick
pick: { <U extends keyof T>(...props: Array<Many<U>>): Object<Pick<T, U>>; (...props: Many<PropertyPath>[]): Object<globalThis.Partial<T>>;};
See Also
_.pick
interface Object
interface Object<T> {}
method pickBy
pickBy: { <S extends T[keyof T]>( predicate: ValueKeyIterateeTypeGuard<T[keyof T], S> ): Object< NumericDictionary<unknown> extends T ? NumericDictionary<S> : Dictionary<S> >; (predicate?: ValueKeyIteratee<T[keyof T]>): Object< T extends Dictionary<unknown> ? Dictionary<T[keyof T]> : T extends NumericDictionary<unknown> ? NumericDictionary<T[keyof T]> : globalThis.Partial<T> >;};
See Also
_.pickBy
interface Object
interface Object<T> {}
method transform
transform: { <TResult>( iteratee: MemoVoidDictionaryIterator<T[keyof T], string, TResult>, accumulator?: TResult ): ImpChain<TResult>; <TResult>( iteratee: MemoVoidDictionaryIterator<T[keyof T], keyof T, TResult>, accumulator?: TResult ): ImpChain<TResult>; (): ImpChain<T extends Dictionary<unknown> ? Dictionary<any> : T>;};
See Also
_.transform
interface Object
interface Object<T> {}
method updateWith
updateWith: { ( path: PropertyPath, updater: (oldValue: any) => any, customizer?: SetWithCustomizer<T> ): this; <TResult>( path: PropertyPath, updater: (oldValue: any) => any, customizer?: SetWithCustomizer<T> ): Object<TResult>;};
See Also
_.updateWith
interface Object
interface Object<T> {}
method values
values: () => Collection<T[keyof T]>;
See Also
_.values
interface Object
interface Object<T> {}
method valuesIn
valuesIn: () => Collection<T[keyof T]>;
See Also
_.valuesIn
interface Object
interface Object<T> {}
method iteratee
iteratee: () => Function<(o: T) => boolean>;
See Also
_.iteratee
interface ObjectChain
interface ObjectChain<T> extends LoDashExplicitWrapper<T> {}
interface ObjectChain
interface ObjectChain<T> {}
method concat
concat: (...values: Array<Many<T>>) => CollectionChain<T>;
See Also
_.concat
interface ObjectChain
interface ObjectChain<T> {}
method countBy
countBy: ( iteratee?: ValueIteratee<T[keyof T]>) => ObjectChain<Dictionary<number>>;
See Also
_.countBy
interface ObjectChain
interface ObjectChain<T> {}
property each
each: ObjectChain<T>['forEach'];
See Also
_.each
interface ObjectChain
interface ObjectChain<T> {}
property eachRight
eachRight: ObjectChain<T>['forEachRight'];
See Also
_.eachRight
interface ObjectChain
interface ObjectChain<T> {}
method every
every: (predicate?: ObjectIterateeCustom<T, boolean>) => PrimitiveChain<boolean>;
See Also
_.every
interface ObjectChain
interface ObjectChain<T> {}
method filter
filter: { <S extends T[keyof T]>( predicate: ObjectIteratorTypeGuard<T, S> ): CollectionChain<S>; (predicate?: ObjectIterateeCustom<T, boolean>): CollectionChain<T[keyof T]>;};
See Also
_.filter
interface ObjectChain
interface ObjectChain<T> {}
method find
find: { <S extends T[keyof T]>( predicate: ObjectIteratorTypeGuard<T, S>, fromIndex?: number ): ExpChain<S | undefined>; (predicate?: ObjectIterateeCustom<T, boolean>, fromIndex?: number): ExpChain< T[keyof T] >;};
See Also
_.find
interface ObjectChain
interface ObjectChain<T> {}
method findLast
findLast: { <S extends T[keyof T]>( predicate: ObjectIteratorTypeGuard<T, S>, fromIndex?: number ): ExpChain<S | undefined>; (predicate?: ObjectIterateeCustom<T, boolean>, fromIndex?: number): ExpChain< T[keyof T] >;};
See Also
_.findLast
interface ObjectChain
interface ObjectChain<T> {}
method flatMap
flatMap: { <TResult = any>( iteratee: ObjectIterator<T, Many<TResult>> | PropertyName ): CollectionChain<TResult>; (iteratee: object | [PropertyName, any]): CollectionChain<boolean>; (): CollectionChain<T[keyof T]>;};
See Also
_.flatMap
interface ObjectChain
interface ObjectChain<T> {}
method flatMapDeep
flatMapDeep: { <TResult = any>( iteratee: | ObjectIterator<T, ListOfRecursiveArraysOrValues<TResult> | TResult> | PropertyName ): CollectionChain<TResult>; (iteratee: object | [PropertyName, any]): CollectionChain<boolean>; (): CollectionChain<T[keyof T]>;};
See Also
_.flatMapDeep
interface ObjectChain
interface ObjectChain<T> {}
method flatMapDepth
flatMapDepth: { <TResult = any>( iteratee: | ObjectIterator<T, ListOfRecursiveArraysOrValues<TResult> | TResult> | PropertyName, depth?: number ): CollectionChain<TResult>; ( iteratee: object | [PropertyName, any], depth?: number ): CollectionChain<boolean>; (depth?: number): CollectionChain<T[keyof T]>;};
See Also
_.flatMapDepth
interface ObjectChain
interface ObjectChain<T> {}
method forEach
forEach: (iteratee?: ObjectIterator<T, any>) => ObjectChain<T>;
See Also
_.forEach
interface ObjectChain
interface ObjectChain<T> {}
method forEachRight
forEachRight: (iteratee?: ObjectIterator<T, any>) => ObjectChain<T>;
See Also
_.forEachRight
interface ObjectChain
interface ObjectChain<T> {}
method groupBy
groupBy: ( iteratee?: ValueIteratee<T[keyof T]>) => ObjectChain<Dictionary<Array<T[keyof T]>>>;
See Also
_.groupBy
interface ObjectChain
interface ObjectChain<T> {}
method includes
includes: (target: T[keyof T], fromIndex?: number) => PrimitiveChain<boolean>;
See Also
_.includes
interface ObjectChain
interface ObjectChain<T> {}
method keyBy
keyBy: ( iteratee?: ValueIterateeCustom<T[keyof T], PropertyName>) => ObjectChain<Dictionary<T[keyof T]>>;
See Also
_.keyBy
interface ObjectChain
interface ObjectChain<T> {}
method map
map: { <K extends keyof T[keyof T]>(key: K): CollectionChain<T[keyof T][K]>; <TResult>(iteratee: ObjectIterator<T, TResult>): CollectionChain<TResult>; (iteratee: PropertyName): CollectionChain<any>; (iteratee: object | [PropertyName, any]): CollectionChain<boolean>; (): CollectionChain<T[keyof T]>;};
See Also
_.map
interface ObjectChain
interface ObjectChain<T> {}
method orderBy
orderBy: ( iteratees?: Many<ObjectIterator<T, NotVoid>>, orders?: Many<boolean | 'asc' | 'desc'>) => CollectionChain<T[keyof T]>;
See Also
_.orderBy
interface ObjectChain
interface ObjectChain<T> {}
method partition
partition: ( callback: ValueIteratee<T[keyof T]>) => LoDashExplicitWrapper<[Array<T[keyof T]>, Array<T[keyof T]>]>;
See Also
_.partition
interface ObjectChain
interface ObjectChain<T> {}
method reduce
reduce: { <TResult>( callback: MemoObjectIterator<T[keyof T], TResult, T>, accumulator: TResult ): ExpChain<TResult>; (callback: MemoObjectIterator<T[keyof T], T[keyof T], T>): ExpChain< T[keyof T] >;};
See Also
_.reduce
interface ObjectChain
interface ObjectChain<T> {}
method reduceRight
reduceRight: { <TResult>( callback: MemoObjectIterator<T[keyof T], TResult, T>, accumulator: TResult ): ExpChain<TResult>; (callback: MemoObjectIterator<T[keyof T], T[keyof T], T>): ExpChain< T[keyof T] >;};
See Also
_.reduceRight
interface ObjectChain
interface ObjectChain<T> {}
method reject
reject: ( predicate?: ObjectIterateeCustom<T, boolean>) => CollectionChain<T[keyof T]>;
See Also
_.reject
interface ObjectChain
interface ObjectChain<T> {}
method sample
sample: () => ExpChain<T[keyof T] | undefined>;
See Also
_.sample
interface ObjectChain
interface ObjectChain<T> {}
method sampleSize
sampleSize: (n?: number) => CollectionChain<T[keyof T]>;
See Also
_.sampleSize
interface ObjectChain
interface ObjectChain<T> {}
method shuffle
shuffle: () => CollectionChain<T[keyof T]>;
See Also
_.shuffle
interface ObjectChain
interface ObjectChain<T> {}
method some
some: (predicate?: ObjectIterateeCustom<T, boolean>) => PrimitiveChain<boolean>;
See Also
_.some
interface ObjectChain
interface ObjectChain<T> {}
method sortBy
sortBy: ( ...iteratees: Array<Many<ObjectIteratee<T>>>) => CollectionChain<T[keyof T]>;
See Also
_.sortBy
interface ObjectChain
interface ObjectChain<T> {}
method castArray
castArray: () => CollectionChain<T>;
See Also
_.castArray
interface ObjectChain
interface ObjectChain<T> {}
method toArray
toArray: () => CollectionChain<T[keyof T]>;
See Also
_.toArray
interface ObjectChain
interface ObjectChain<T> {}
method assign
assign: { <TSource>(source: TSource): ObjectChain<T & TSource>; <TSource1, TSource2>(source1: TSource1, source2: TSource2): ObjectChain< T & TSource1 & TSource2 >; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3 ): ObjectChain<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): ObjectChain<T & TSource1 & TSource2 & TSource3 & TSource4>; (): ObjectChain<T>; (...otherArgs: any[]): ObjectChain<any>;};
See Also
_.assign
interface ObjectChain
interface ObjectChain<T> {}
method assignIn
assignIn: { <TSource>(source: TSource): ObjectChain<T & TSource>; <TSource1, TSource2>(source1: TSource1, source2: TSource2): ObjectChain< T & TSource1 & TSource2 >; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3 ): ObjectChain<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): ObjectChain<T & TSource1 & TSource2 & TSource3 & TSource4>; (): ObjectChain<T>; (...otherArgs: any[]): ObjectChain<any>;};
See Also
_.assignIn
interface ObjectChain
interface ObjectChain<T> {}
method assignInWith
assignInWith: { <TSource>(source: TSource, customizer: AssignCustomizer): ObjectChain< T & TSource >; <TSource1, TSource2>( source1: TSource1, source2: TSource2, customizer: AssignCustomizer ): ObjectChain<T & TSource1 & TSource2>; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer ): ObjectChain<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer ): ObjectChain<T & TSource1 & TSource2 & TSource3 & TSource4>; (): ObjectChain<T>; (...otherArgs: any[]): ObjectChain<any>;};
See Also
_.assignInWith
interface ObjectChain
interface ObjectChain<T> {}
method assignWith
assignWith: { <TSource>(source: TSource, customizer: AssignCustomizer): ObjectChain< T & TSource >; <TSource1, TSource2>( source1: TSource1, source2: TSource2, customizer: AssignCustomizer ): ObjectChain<T & TSource1 & TSource2>; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer ): ObjectChain<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer ): ObjectChain<T & TSource1 & TSource2 & TSource3 & TSource4>; (): ObjectChain<T>; (...otherArgs: any[]): ObjectChain<any>;};
See Also
_.assignWith
interface ObjectChain
interface ObjectChain<T> {}
method at
at: (...props: Array<Many<keyof T>>) => CollectionChain<T[keyof T]>;
See Also
_.at
interface ObjectChain
interface ObjectChain<T> {}
method create
create: <U extends object>(properties?: U) => ObjectChain<T & U>;
See Also
_.create
interface ObjectChain
interface ObjectChain<T> {}
method defaults
defaults: { <TSource>(source: TSource): ObjectChain<NonNullable<TSource & T>>; <TSource1, TSource2>(source1: TSource1, source2: TSource2): ObjectChain< NonNullable<TSource2 & TSource1 & T> >; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3 ): ObjectChain<NonNullable<TSource3 & TSource2 & TSource1 & T>>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): ObjectChain<NonNullable<TSource4 & TSource3 & TSource2 & TSource1 & T>>; (): ObjectChain<NonNullable<T>>; (...sources: any[]): ObjectChain<any>;};
See Also
_.defaults
interface ObjectChain
interface ObjectChain<T> {}
method defaultsDeep
defaultsDeep: (...sources: any[]) => ObjectChain<any>;
See Also
_.defaultsDeep
interface ObjectChain
interface ObjectChain<T> {}
method entries
entries: () => CollectionChain<[string, T[keyof T]]>;
See Also
_.entries
interface ObjectChain
interface ObjectChain<T> {}
method entriesIn
entriesIn: () => CollectionChain<[string, T[keyof T]]>;
See Also
_.entriesIn
interface ObjectChain
interface ObjectChain<T> {}
method extend
extend: { <TSource>(source: TSource): ObjectChain<T & TSource>; <TSource1, TSource2>(source1: TSource1, source2: TSource2): ObjectChain< T & TSource1 & TSource2 >; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3 ): ObjectChain<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): ObjectChain<T & TSource1 & TSource2 & TSource3 & TSource4>; (): ObjectChain<T>; (...otherArgs: any[]): ObjectChain<any>;};
See Also
_.extend
interface ObjectChain
interface ObjectChain<T> {}
method extendWith
extendWith: { <TSource>(source: TSource, customizer: AssignCustomizer): ObjectChain< T & TSource >; <TSource1, TSource2>( source1: TSource1, source2: TSource2, customizer: AssignCustomizer ): ObjectChain<T & TSource1 & TSource2>; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer ): ObjectChain<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer ): ObjectChain<T & TSource1 & TSource2 & TSource3 & TSource4>; (): ObjectChain<T>; (...otherArgs: any[]): ObjectChain<any>;};
See Also
_.extendWith
interface ObjectChain
interface ObjectChain<T> {}
method get
get: { <TKey extends keyof T>(path: TKey | [TKey]): ExpChain<T[TKey]>; <TKey extends keyof T>( path: TKey | [TKey], defaultValue: never[] ): T[TKey] extends any[] ? ExpChain<Exclude<T[TKey], undefined>> : CollectionChain<never> | ExpChain<Exclude<T[TKey], undefined>>; <TKey extends keyof T, TDefault>( path: TKey | [TKey], defaultValue: TDefault ): ExpChain<TDefault> | ExpChain<Exclude<T[TKey], undefined>>; <TKey1 extends keyof T, TKey2 extends keyof T[TKey1]>( path: [TKey1, TKey2] ): ExpChain<T[TKey1][TKey2]>; <TKey1 extends keyof T, TKey2 extends keyof T[TKey1]>( path: [TKey1, TKey2], defaultValue: never[] ): T[TKey1][TKey2] extends any[] ? ExpChain<Exclude<T[TKey1][TKey2], undefined>> : CollectionChain<never> | ExpChain<Exclude<T[TKey1][TKey2], undefined>>; <TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TDefault>( path: [TKey1, TKey2], defaultValue: TDefault ): ExpChain<TDefault> | ExpChain<Exclude<T[TKey1][TKey2], undefined>>; < TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TKey3 extends keyof T[TKey1][TKey2] >( path: [TKey1, TKey2, TKey3] ): ExpChain<T[TKey1][TKey2][TKey3]>; < TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TKey3 extends keyof T[TKey1][TKey2] >( path: [TKey1, TKey2, TKey3], defaultValue: never[] ): T[TKey1][TKey2][TKey3] extends any[] ? ExpChain<Exclude<T[TKey1][TKey2][TKey3], undefined>> : | CollectionChain<never> | ExpChain<Exclude<T[TKey1][TKey2][TKey3], undefined>>; < TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TKey3 extends keyof T[TKey1][TKey2], TDefault >( path: [TKey1, TKey2, TKey3], defaultValue: TDefault ): ExpChain<TDefault> | ExpChain<Exclude<T[TKey1][TKey2][TKey3], undefined>>; < TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TKey3 extends keyof T[TKey1][TKey2], TKey4 extends keyof T[TKey1][TKey2][TKey3] >( path: [TKey1, TKey2, TKey3, TKey4] ): ExpChain<T[TKey1][TKey2][TKey3][TKey4]>; < TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TKey3 extends keyof T[TKey1][TKey2], TKey4 extends keyof T[TKey1][TKey2][TKey3] >( path: [TKey1, TKey2, TKey3, TKey4], defaultValue: never[] ): T[TKey1][TKey2][TKey3][TKey4] extends any[] ? ExpChain<Exclude<T[TKey1][TKey2][TKey3][TKey4], undefined>> : | CollectionChain<never> | ExpChain<Exclude<T[TKey1][TKey2][TKey3][TKey4], undefined>>; < TKey1 extends keyof T, TKey2 extends keyof T[TKey1], TKey3 extends keyof T[TKey1][TKey2], TKey4 extends keyof T[TKey1][TKey2][TKey3], TDefault >( path: [TKey1, TKey2, TKey3, TKey4], defaultValue: TDefault ): | ExpChain<TDefault> | ExpChain<Exclude<T[TKey1][TKey2][TKey3][TKey4], undefined>>; <TPath extends string>(path: TPath): string extends TPath ? LoDashExplicitWrapper<any> : ExpChain<GetFieldType<T, TPath, 'Path'>>; <TPath extends string, TDefault = GetFieldType<T, TPath, 'Path'>>( path: TPath, defaultValue: TDefault ): | ExpChain<TDefault> | ExpChain<Exclude<GetFieldType<T, TPath, 'Path'>, null>>; (path: PropertyPath, defaultValue?: any): LoDashExplicitWrapper<any>;};
See Also
_.get
interface ObjectChain
interface ObjectChain<T> {}
method invertBy
invertBy: ( iteratee?: ValueIteratee<T[keyof T]>) => ObjectChain<Dictionary<string[]>>;
See Also
_.invertBy
interface ObjectChain
interface ObjectChain<T> {}
method mapKeys
mapKeys: (iteratee?: ObjectIteratee<T>) => ObjectChain<Dictionary<T[keyof T]>>;
See Also
_.mapKeys
interface ObjectChain
interface ObjectChain<T> {}
method mapValues
mapValues: { <TResult>(callback: ObjectIterator<T, TResult>): ObjectChain<{ [P in keyof T]: TResult; }>; <TResult>(callback: DictionaryIterator<T[keyof T], TResult>): ObjectChain< Dictionary<TResult> >; (iteratee: object): ObjectChain<{ [P in keyof T]: boolean }>; <TKey extends keyof T[keyof T]>(iteratee: TKey): ObjectChain< Dictionary<T[keyof T][TKey]> >; (iteratee: string): ObjectChain<{ [P in keyof T]: any }>; (): ObjectChain<T>;};
See Also
_.mapValues
interface ObjectChain
interface ObjectChain<T> {}
method merge
merge: { <TSource>(source: TSource): ObjectChain<T & TSource>; <TSource1, TSource2>(source1: TSource1, source2: TSource2): ObjectChain< T & TSource1 & TSource2 >; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3 ): ObjectChain<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4 ): ObjectChain<T & TSource1 & TSource2 & TSource3 & TSource4>; (...otherArgs: any[]): ObjectChain<any>;};
See Also
_.merge
interface ObjectChain
interface ObjectChain<T> {}
method mergeWith
mergeWith: { <TSource>(source: TSource, customizer: MergeWithCustomizer): ObjectChain< T & TSource >; <TSource1, TSource2>( source1: TSource1, source2: TSource2, customizer: ( value: any, srcValue: any, key: string, object: any, source: any ) => any ): ObjectChain<T & TSource1 & TSource2>; <TSource1, TSource2, TSource3>( source1: TSource1, source2: TSource2, source3: TSource3, customizer: ( value: any, srcValue: any, key: string, object: any, source: any ) => any ): ObjectChain<T & TSource1 & TSource2 & TSource3>; <TSource1, TSource2, TSource3, TSource4>( source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: ( value: any, srcValue: any, key: string, object: any, source: any ) => any ): ObjectChain<T & TSource1 & TSource2 & TSource3 & TSource4>; (...otherArgs: any[]): ObjectChain<any>;};
See Also
_.mergeWith
interface ObjectChain
interface ObjectChain<T> {}
method omit
omit: { <K extends keyof T>(...paths: Array<Many<K>>): ObjectChain<Omit<T, K>>; (...paths: Many<PropertyName>[]): ObjectChain<globalThis.Partial<T>>;};
See Also
_.omit
interface ObjectChain
interface ObjectChain<T> {}
method omitBy
omitBy: ( predicate: ValueKeyIteratee<T[keyof T]>) => ObjectChain<PartialObject<T>>;
See Also
_.omitBy
interface ObjectChain
interface ObjectChain<T> {}
method pick
pick: { <U extends keyof T>(...props: Array<Many<U>>): ObjectChain<Pick<T, U>>; (...props: Many<PropertyPath>[]): ObjectChain<globalThis.Partial<T>>;};
See Also
_.pick
interface ObjectChain
interface ObjectChain<T> {}
method pickBy
pickBy: { <S extends T[keyof T]>( predicate: ValueKeyIterateeTypeGuard<T[keyof T], S> ): ObjectChain< NumericDictionary<unknown> extends T ? NumericDictionary<S> : Dictionary<S> >; (predicate?: ValueKeyIteratee<T[keyof T]>): ObjectChain< T extends Dictionary<unknown> ? Dictionary<T[keyof T]> : T extends NumericDictionary<unknown> ? NumericDictionary<T[keyof T]> : globalThis.Partial<T> >;};
See Also
_.pickBy
interface ObjectChain
interface ObjectChain<T> {}
method transform
transform: { <TResult>( iteratee: MemoVoidDictionaryIterator<T[keyof T], string, TResult>, accumulator?: TResult ): ExpChain<TResult>; <TResult>( iteratee: MemoVoidDictionaryIterator<T[keyof T], keyof T, TResult>, accumulator?: TResult ): ExpChain<TResult>; (): ExpChain<T extends Dictionary<unknown> ? Dictionary<any> : T>;};
See Also
_.transform
interface ObjectChain
interface ObjectChain<T> {}
method updateWith
updateWith: { ( path: PropertyPath, updater: (oldValue: any) => any, customizer?: SetWithCustomizer<T> ): this; <TResult>( path: PropertyPath, updater: (oldValue: any) => any, customizer?: SetWithCustomizer<T> ): ObjectChain<TResult>;};
See Also
_.updateWith
interface ObjectChain
interface ObjectChain<T> {}
method values
values: () => CollectionChain<T[keyof T]>;
See Also
_.values
interface ObjectChain
interface ObjectChain<T> {}
method valuesIn
valuesIn: () => CollectionChain<T[keyof T]>;
See Also
_.valuesIn
interface ObjectChain
interface ObjectChain<T> {}
method iteratee
iteratee: () => FunctionChain<(o: T) => boolean>;
See Also
_.iteratee
interface Partial
interface Partial {}
property placeholder
placeholder: __;
call signature
<T1, T2, R>(func: Function2<T1, T2, R>, plc1: __, arg2: T2): Function1<T1, R>;
call signature
<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, plc1: __, arg2: T2): Function2< T1, T3, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, plc3: __, arg4: T4): Function2<T2, T3, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, plc1: __, arg2: T2, plc3: __, arg4: T4): Function2<T1, T3, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: __, arg4: T4): Function1<T3, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, plc1: __, plc2: __, arg3: T3, arg4: T4): Function2<T1, T2, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, arg3: T3, arg4: T4): Function1<T2, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, plc1: __, arg2: T2, arg3: T3, arg4: T4): Function1<T1, R>;
call signature
<TS extends any[], R>(func: (...ts: TS) => R): (...ts: TS) => R;
call signature
<TS extends any[], T1, R>(func: (t1: T1, ...ts: TS) => R, arg1: T1): ( ...ts: TS) => R;
call signature
<TS extends any[], T1, T2, R>( func: (t1: T1, t2: T2, ...ts: TS) => R, t1: T1, t2: T2): (...ts: TS) => R;
call signature
<TS extends any[], T1, T2, T3, R>( func: (t1: T1, t2: T2, t3: T3, ...ts: TS) => R, t1: T1, t2: T2, t3: T3): (...ts: TS) => R;
call signature
<T1, T2, T3, R>( func: Function3<T1, T2, T3, R>, plc1: __, plc2: __, arg3: T3): Function2<T1, T2, R>;
call signature
<TS extends any[], T1, T2, T3, T4, R>( func: (t1: T1, t2: T2, t3: T3, t4: T4, ...ts: TS) => R, t1: T1, t2: T2, t3: T3, t4: T4): (...ts: TS) => R;
call signature
<T1, T2, T3, R>( func: Function3<T1, T2, T3, R>, arg1: T1, plc2: __, arg3: T3): Function1<T2, R>;
call signature
<T1, T2, T3, R>( func: Function3<T1, T2, T3, R>, plc1: __, arg2: T2, arg3: T3): Function1<T1, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, plc1: __, arg2: T2): Function3<T1, T3, T4, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, plc1: __, plc2: __, arg3: T3): Function3<T1, T2, T4, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, arg3: T3): Function2<T2, T4, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, plc1: __, arg2: T2, arg3: T3): Function2<T1, T4, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, plc1: __, plc2: __, plc3: __, arg4: T4): Function3<T1, T2, T3, R>;
interface PartialRight
interface PartialRight {}
property placeholder
placeholder: __;
call signature
<R>(func: Function0<R>): Function0<R>;
call signature
<T1, R>(func: Function1<T1, R>): Function1<T1, R>;
call signature
<T1, T2, T3, R>( func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2, plc3: __): Function1<T3, R>;
call signature
<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg3: T3): Function2<T1, T2, R>;
call signature
<T1, T2, T3, R>( func: Function3<T1, T2, T3, R>, arg1: T1, plc2: __, arg3: T3): Function1<T2, R>;
call signature
<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg2: T2, arg3: T3): Function1< T1, R>;
call signature
<T1, T2, T3, R>( func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): Function0<R>;
call signature
<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>): Function4< T1, T2, T3, T4, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, plc3: __, plc4: __): Function3<T2, T3, T4, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg2: T2, plc3: __, plc4: __): Function3<T1, T3, T4, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: __, plc4: __): Function2<T3, T4, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg3: T3, plc4: __): Function3<T1, T2, T4, R>;
call signature
<T1, R>(func: Function1<T1, R>, arg1: T1): Function0<R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, arg3: T3, plc4: __): Function2<T2, T4, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg2: T2, arg3: T3, plc4: __): Function2<T1, T4, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, plc4: __): Function1<T4, R>;
call signature
<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg4: T4): Function3< T1, T2, T3, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, plc3: __, arg4: T4): Function2<T2, T3, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg2: T2, plc3: __, arg4: T4): Function2<T1, T3, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: __, arg4: T4): Function1<T3, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg3: T3, arg4: T4): Function2<T1, T2, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, arg3: T3, arg4: T4): Function1<T2, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg2: T2, arg3: T3, arg4: T4): Function1<T1, R>;
call signature
<T1, T2, R>(func: Function2<T1, T2, R>): Function2<T1, T2, R>;
call signature
<T1, T2, T3, T4, R>( func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): Function0<R>;
call signature
(func: (...args: any[]) => any, ...args: any[]): (...args: any[]) => any;
call signature
<T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1, plc2: __): Function1<T2, R>;
call signature
<T1, T2, R>(func: Function2<T1, T2, R>, arg2: T2): Function1<T1, R>;
call signature
<T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1, arg2: T2): Function0<R>;
call signature
<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>): Function3<T1, T2, T3, R>;
call signature
<T1, T2, T3, R>( func: Function3<T1, T2, T3, R>, arg1: T1, plc2: __, plc3: __): Function2<T2, T3, R>;
call signature
<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg2: T2, plc3: __): Function2< T1, T3, R>;
interface Primitive
interface Primitive<T> extends LoDashImplicitWrapper<T> {}
interface Primitive
interface Primitive<T> {}
method concat
concat: (...values: Array<Many<T>>) => Collection<T>;
See Also
_.concat
interface Primitive
interface Primitive<T> {}
method after
after: <TFunc extends (...args: any[]) => any>(func: TFunc) => Function<TFunc>;
See Also
_.after
interface Primitive
interface Primitive<T> {}
method before
before: <TFunc extends (...args: any[]) => any>(func: TFunc) => Function<TFunc>;
See Also
_.before
interface Primitive
interface Primitive<T> {}
method castArray
castArray: () => Collection<T>;
See Also
_.castArray
interface Primitive
interface Primitive<T> {}
method chain
chain: () => PrimitiveChain<T>;
See Also
_.chain
interface PrimitiveChain
interface PrimitiveChain<T> extends LoDashExplicitWrapper<T> {}
interface PrimitiveChain
interface PrimitiveChain<T> {}
method concat
concat: (...values: Array<Many<T>>) => CollectionChain<T>;
See Also
_.concat
interface PrimitiveChain
interface PrimitiveChain<T> {}
method after
after: <TFunc extends (...args: any[]) => any>( func: TFunc) => FunctionChain<TFunc>;
See Also
_.after
interface PrimitiveChain
interface PrimitiveChain<T> {}
method before
before: <TFunc extends (...args: any[]) => any>( func: TFunc) => FunctionChain<TFunc>;
See Also
_.before
interface PrimitiveChain
interface PrimitiveChain<T> {}
method castArray
castArray: () => CollectionChain<T>;
See Also
_.castArray
interface RecursiveArray
interface RecursiveArray<T> extends Array<T | RecursiveArray<T>> {}
interface RightCurriedFunction1
interface RightCurriedFunction1<T1, R> {}
call signature
(): RightCurriedFunction1<T1, R>;
call signature
(t1: T1): R;
interface RightCurriedFunction2
interface RightCurriedFunction2<T1, T2, R> {}
call signature
(): RightCurriedFunction2<T1, T2, R>;
call signature
(t2: T2): RightCurriedFunction1<T1, R>;
call signature
(t1: T1, t2: __): RightCurriedFunction1<T2, R>;
call signature
(t1: T1, t2: T2): R;
interface RightCurriedFunction3
interface RightCurriedFunction3<T1, T2, T3, R> {}
call signature
(): RightCurriedFunction3<T1, T2, T3, R>;
call signature
(t3: T3): RightCurriedFunction2<T1, T2, R>;
call signature
(t2: T2, t3: __): RightCurriedFunction2<T1, T3, R>;
call signature
(t2: T2, t3: T3): RightCurriedFunction1<T1, R>;
call signature
(t1: T1, t2: __, t3: __): RightCurriedFunction2<T2, T3, R>;
call signature
(t1: T1, t2: T2, t3: __): RightCurriedFunction1<T3, R>;
call signature
(t1: T1, t2: __, t3: T3): RightCurriedFunction1<T2, R>;
call signature
(t1: T1, t2: T2, t3: T3): R;
interface RightCurriedFunction4
interface RightCurriedFunction4<T1, T2, T3, T4, R> {}
call signature
(): RightCurriedFunction4<T1, T2, T3, T4, R>;
call signature
(t4: T4): RightCurriedFunction3<T1, T2, T3, R>;
call signature
(t1: T1, t2: __, t3: T3, t4: __): RightCurriedFunction2<T2, T4, R>;
call signature
(t1: T1, t2: __, t3: __, t4: T4): RightCurriedFunction2<T2, T3, R>;
call signature
(t1: T1, t2: T2, t3: T3, t4: __): RightCurriedFunction1<T4, R>;
call signature
(t1: T1, t2: T2, t3: __, t4: T4): RightCurriedFunction1<T3, R>;
call signature
(t1: T1, t2: __, t3: T3, t4: T4): RightCurriedFunction1<T2, R>;
call signature
(t1: T1, t2: T2, t3: T3, t4: T4): R;
call signature
(t3: T3, t4: __): RightCurriedFunction3<T1, T2, T4, R>;
call signature
(t3: T3, t4: T4): RightCurriedFunction2<T1, T2, R>;
call signature
(t2: T2, t3: __, t4: __): RightCurriedFunction3<T1, T3, T4, R>;
call signature
(t2: T2, t3: T3, t4: __): RightCurriedFunction2<T1, T4, R>;
call signature
(t2: T2, t3: __, t4: T4): RightCurriedFunction2<T1, T3, R>;
call signature
(t2: T2, t3: T3, t4: T4): RightCurriedFunction1<T1, R>;
call signature
(t1: T1, t2: __, t3: __, t4: __): RightCurriedFunction3<T2, T3, T4, R>;
call signature
(t1: T1, t2: T2, t3: __, t4: __): RightCurriedFunction2<T3, T4, R>;
interface RightCurriedFunction5
interface RightCurriedFunction5<T1, T2, T3, T4, T5, R> {}
call signature
(): RightCurriedFunction5<T1, T2, T3, T4, T5, R>;
call signature
(t5: T5): RightCurriedFunction4<T1, T2, T3, T4, R>;
call signature
(t2: T2, t3: __, t4: T4, t5: __): RightCurriedFunction3<T1, T3, T5, R>;
call signature
(t2: T2, t3: __, t4: __, t5: T5): RightCurriedFunction3<T1, T3, T4, R>;
call signature
(t2: T2, t3: T3, t4: T4, t5: __): RightCurriedFunction2<T1, T5, R>;
call signature
(t2: T2, t3: T3, t4: __, t5: T5): RightCurriedFunction2<T1, T4, R>;
call signature
(t2: T2, t3: __, t4: T4, t5: T5): RightCurriedFunction2<T1, T3, R>;
call signature
(t2: T2, t3: T3, t4: T4, t5: T5): RightCurriedFunction1<T1, R>;
call signature
(t1: T1, t2: __, t3: __, t4: __, t5: __): RightCurriedFunction4< T2, T3, T4, T5, R>;
call signature
(t1: T1, t2: T2, t3: __, t4: __, t5: __): RightCurriedFunction3<T3, T4, T5, R>;
call signature
(t1: T1, t2: __, t3: T3, t4: __, t5: __): RightCurriedFunction3<T2, T4, T5, R>;
call signature
(t1: T1, t2: __, t3: __, t4: T4, t5: __): RightCurriedFunction3<T2, T3, T5, R>;
call signature
(t4: T4, t5: __): RightCurriedFunction4<T1, T2, T3, T5, R>;
call signature
(t1: T1, t2: __, t3: __, t4: __, t5: T5): RightCurriedFunction3<T2, T3, T4, R>;
call signature
(t1: T1, t2: T2, t3: T3, t4: __, t5: __): RightCurriedFunction2<T4, T5, R>;
call signature
(t1: T1, t2: T2, t3: __, t4: T4, t5: __): RightCurriedFunction2<T3, T5, R>;
call signature
(t1: T1, t2: T2, t3: __, t4: __, t5: T5): RightCurriedFunction2<T3, T4, R>;
call signature
(t1: T1, t2: __, t3: T3, t4: T4, t5: __): RightCurriedFunction2<T2, T5, R>;
call signature
(t1: T1, t2: __, t3: T3, t4: __, t5: T5): RightCurriedFunction2<T2, T4, R>;
call signature
(t1: T1, t2: __, t3: __, t4: T4, t5: T5): RightCurriedFunction2<T2, T3, R>;
call signature
(t1: T1, t2: T2, t3: T3, t4: T4, t5: __): RightCurriedFunction1<T5, R>;
call signature
(t1: T1, t2: T2, t3: T3, t4: __, t5: T5): RightCurriedFunction1<T4, R>;
call signature
(t1: T1, t2: T2, t3: __, t4: T4, t5: T5): RightCurriedFunction1<T3, R>;
call signature
(t4: T4, t5: T5): RightCurriedFunction3<T1, T2, T3, R>;
call signature
(t1: T1, t2: __, t3: T3, t4: T4, t5: T5): RightCurriedFunction1<T2, R>;
call signature
(t1: T1, t2: T2, t3: T3, t4: T4, t5: T5): R;
call signature
(t3: T3, t4: __, t5: __): RightCurriedFunction4<T1, T2, T4, T5, R>;
call signature
(t3: T3, t4: T4, t5: __): RightCurriedFunction3<T1, T2, T5, R>;
call signature
(t3: T3, t4: __, t5: T5): RightCurriedFunction3<T1, T2, T4, R>;
call signature
(t3: T3, t4: T4, t5: T5): RightCurriedFunction2<T1, T2, R>;
call signature
(t2: T2, t3: __, t4: __, t5: __): RightCurriedFunction4<T1, T3, T4, T5, R>;
call signature
(t2: T2, t3: T3, t4: __, t5: __): RightCurriedFunction3<T1, T4, T5, R>;
interface String
interface String<T extends string = string> extends LoDashImplicitWrapper<T> {}
interface String
interface String {}
method flatten
flatten: () => Collection<string>;
See Also
_.flatten
interface String
interface String {}
method countBy
countBy: (iteratee?: ValueIteratee<string>) => Object<Dictionary<number>>;
See Also
_.countBy
interface String
interface String {}
property eachRight
eachRight: String['forEachRight'];
See Also
_.eachRight
interface String
interface String {}
method filter
filter: (predicate?: StringIterator<boolean>) => Collection<string>;
See Also
_.filter
interface String
interface String {}
method flatMap
flatMap: { <TResult>(iteratee: StringIterator<Many<TResult>>): Collection<TResult>; (): Collection<string>;};
See Also
_.flatMap
interface String
interface String {}
method flatMapDeep
flatMapDeep: { <TResult>( iteratee: StringIterator< ListOfRecursiveArraysOrValues<TResult> | TResult > ): Collection<TResult>; (): Collection<string>;};
See Also
_.flatMapDeep
interface String
interface String {}
method flatMapDepth
flatMapDepth: { <TResult>( iteratee: StringIterator< ListOfRecursiveArraysOrValues<TResult> | TResult >, depth?: number ): Collection<TResult>; (depth?: number): Collection<string>;};
See Also
_.flatMapDepth
interface String
interface String {}
method forEach
forEach: (iteratee?: StringIterator<any>) => String;
See Also
_.forEach
interface String
interface String {}
method forEachRight
forEachRight: (iteratee?: StringIterator<any>) => String;
See Also
_.forEachRight
interface String
interface String {}
method groupBy
groupBy: (iteratee?: ValueIteratee<string>) => Object<Dictionary<string[]>>;
See Also
_.groupBy
interface String
interface String {}
method includes
includes: (target: string, fromIndex?: number) => boolean;
See Also
_.includes
interface String
interface String {}
method keyBy
keyBy: ( iteratee?: ValueIterateeCustom<string, PropertyName>) => Object<Dictionary<string>>;
See Also
_.keyBy
interface String
interface String {}
method map
map: { <TResult>(iteratee: StringIterator<TResult>): Collection<TResult>; (): Collection<string>;};
See Also
_.map
interface String
interface String {}
method partition
partition: ( callback: StringIterator<NotVoid>) => LoDashImplicitWrapper<[string[], string[]]>;
See Also
_.partition
interface String
interface String {}
method reject
reject: (predicate?: StringIterator<boolean>) => Collection<string>;
See Also
_.reject
interface String
interface String {}
method sampleSize
sampleSize: (n?: number) => Collection<string>;
See Also
_.sampleSize
interface String
interface String {}
method shuffle
shuffle: () => Collection<string>;
See Also
_.shuffle
interface String
interface String {}
method castArray
castArray: () => Collection<string>;
See Also
_.castArray
interface String
interface String {}
method toArray
toArray: () => Collection<string>;
See Also
_.toArray
interface String
interface String {}
method get
get: { (path: number | number[]): string; (path: number | number[], defaultValue: string): string;};
See Also
_.get
interface String
interface String {}
method invertBy
invertBy: (iteratee?: ValueIteratee<string>) => Object<Dictionary<string[]>>;
See Also
_.invertBy
interface String
interface String {}
method mapValues
mapValues: { <TResult>(callback: StringIterator<TResult>): Object< NumericDictionary<TResult> >; (): Object<NumericDictionary<string>>;};
See Also
_.mapValues
interface String
interface String {}
method valuesIn
valuesIn: () => Collection<string>;
See Also
_.valuesIn
interface String
interface String {}
method chain
chain: <T extends string>() => StringChain<T>;
See Also
_.chain
interface String
interface String {}
method iteratee
iteratee: () => Function<(o: object) => any>;
See Also
_.iteratee
interface StringChain
interface StringChain<T extends string = string> extends LoDashExplicitWrapper<T> {}
interface StringChain
interface StringChain {}
method first
first: () => StringNullableChain;
See Also
_.first
interface StringChain
interface StringChain {}
method flatten
flatten: () => CollectionChain<string>;
See Also
_.flatten
interface StringChain
interface StringChain {}
method head
head: () => StringNullableChain;
See Also
_.head
interface StringChain
interface StringChain {}
method join
join: (separator?: string) => StringChain;
See Also
_.join
interface StringChain
interface StringChain {}
method last
last: () => StringNullableChain;
See Also
_.last
interface StringChain
interface StringChain {}
method countBy
countBy: (iteratee?: ValueIteratee<string>) => ObjectChain<Dictionary<number>>;
See Also
_.countBy
interface StringChain
interface StringChain {}
property each
each: StringChain['forEach'];
See Also
_.each
interface StringChain
interface StringChain {}
property eachRight
eachRight: StringChain['forEachRight'];
See Also
_.eachRight
interface StringChain
interface StringChain {}
method filter
filter: (predicate?: StringIterator<boolean>) => CollectionChain<string>;
See Also
_.filter
interface StringChain
interface StringChain {}
method flatMap
flatMap: { <TResult>(iteratee: StringIterator<Many<TResult>>): CollectionChain<TResult>; (): CollectionChain<string>;};
See Also
_.flatMap
interface StringChain
interface StringChain {}
method flatMapDeep
flatMapDeep: { <TResult>( iteratee: StringIterator< ListOfRecursiveArraysOrValues<TResult> | TResult > ): CollectionChain<TResult>; (): CollectionChain<string>;};
See Also
_.flatMapDeep
interface StringChain
interface StringChain {}
method flatMapDepth
flatMapDepth: { <TResult>( iteratee: StringIterator< ListOfRecursiveArraysOrValues<TResult> | TResult >, depth?: number ): CollectionChain<TResult>; (depth?: number): CollectionChain<string>;};
See Also
_.flatMapDepth
interface StringChain
interface StringChain {}
method forEach
forEach: (iteratee?: StringIterator<any>) => StringChain;
See Also
_.forEach
interface StringChain
interface StringChain {}
method forEachRight
forEachRight: (iteratee?: StringIterator<any>) => StringChain;
See Also
_.forEachRight
interface StringChain
interface StringChain {}
method groupBy
groupBy: (iteratee?: ValueIteratee<string>) => ObjectChain<Dictionary<string[]>>;
See Also
_.groupBy
interface StringChain
interface StringChain {}
method includes
includes: (target: string, fromIndex?: number) => PrimitiveChain<boolean>;
See Also
_.includes
interface StringChain
interface StringChain {}
method keyBy
keyBy: ( iteratee?: ValueIterateeCustom<string, PropertyName>) => ObjectChain<Dictionary<string>>;
See Also
_.keyBy
interface StringChain
interface StringChain {}
method map
map: { <TResult>(iteratee: StringIterator<TResult>): CollectionChain<TResult>; (): CollectionChain<string>;};
See Also
_.map
interface StringChain
interface StringChain {}
method partition
partition: ( callback: StringIterator<NotVoid>) => LoDashExplicitWrapper<[string[], string[]]>;
See Also
_.partition
interface StringChain
interface StringChain {}
method reject
reject: (predicate?: StringIterator<boolean>) => CollectionChain<string>;
See Also
_.reject
interface StringChain
interface StringChain {}
method sample
sample: () => StringNullableChain;
See Also
_.sample
interface StringChain
interface StringChain {}
method sampleSize
sampleSize: (n?: number) => CollectionChain<string>;
See Also
_.sampleSize
interface StringChain
interface StringChain {}
method shuffle
shuffle: () => CollectionChain<string>;
See Also
_.shuffle
interface StringChain
interface StringChain {}
method castArray
castArray: () => CollectionChain<string>;
See Also
_.castArray
interface StringChain
interface StringChain {}
method toArray
toArray: () => CollectionChain<string>;
See Also
_.toArray
interface StringChain
interface StringChain {}
method get
get: { (path: number | number[]): StringChain; (path: number | number[], defaultValue: string): StringChain<string>;};
See Also
_.get
interface StringChain
interface StringChain {}
method invertBy
invertBy: ( iteratee?: ValueIteratee<string>) => ObjectChain<Dictionary<string[]>>;
See Also
_.invertBy
interface StringChain
interface StringChain {}
method mapValues
mapValues: { <TResult>(callback: StringIterator<TResult>): ObjectChain< NumericDictionary<TResult> >; (): ObjectChain<NumericDictionary<string>>;};
See Also
_.mapValues
interface StringChain
interface StringChain {}
method values
values: () => CollectionChain<string>;
See Also
_.values
interface StringChain
interface StringChain {}
method valuesIn
valuesIn: () => CollectionChain<string>;
See Also
_.valuesIn
interface StringChain
interface StringChain {}
method iteratee
iteratee: () => FunctionChain<(o: object) => any>;
See Also
_.iteratee
interface StringNullableChain
interface StringNullableChain extends LoDashExplicitWrapper<string | undefined> {}
interface StringNullableChain
interface StringNullableChain {}
method first
first: () => StringNullableChain;
See Also
_.first
interface StringNullableChain
interface StringNullableChain {}
method flatten
flatten: () => CollectionChain<string>;
See Also
_.flatten
interface StringNullableChain
interface StringNullableChain {}
method head
head: () => StringNullableChain;
See Also
_.head
interface StringNullableChain
interface StringNullableChain {}
method join
join: (separator?: string) => StringChain;
See Also
_.join
interface StringNullableChain
interface StringNullableChain {}
method last
last: () => StringNullableChain;
See Also
_.last
interface StringNullableChain
interface StringNullableChain {}
method countBy
countBy: (iteratee?: ValueIteratee<string>) => ObjectChain<Dictionary<number>>;
See Also
_.countBy
interface StringNullableChain
interface StringNullableChain {}
property each
each: StringNullableChain['forEach'];
See Also
_.each
interface StringNullableChain
interface StringNullableChain {}
property eachRight
eachRight: StringNullableChain['forEachRight'];
See Also
_.eachRight
interface StringNullableChain
interface StringNullableChain {}
method filter
filter: (predicate?: StringIterator<boolean>) => CollectionChain<string>;
See Also
_.filter
interface StringNullableChain
interface StringNullableChain {}
method flatMap
flatMap: { <TResult>(iteratee: StringIterator<Many<TResult>>): CollectionChain<TResult>; (): CollectionChain<string>;};
See Also
_.flatMap
interface StringNullableChain
interface StringNullableChain {}
method flatMapDeep
flatMapDeep: { <TResult>( iteratee: StringIterator< ListOfRecursiveArraysOrValues<TResult> | TResult > ): CollectionChain<TResult>; (): CollectionChain<string>;};
See Also
_.flatMapDeep
interface StringNullableChain
interface StringNullableChain {}
method flatMapDepth
flatMapDepth: { <TResult>( iteratee: StringIterator< ListOfRecursiveArraysOrValues<TResult> | TResult >, depth?: number ): CollectionChain<TResult>; (depth?: number): CollectionChain<string>;};
See Also
_.flatMapDepth
interface StringNullableChain
interface StringNullableChain {}
method forEach
forEach: (iteratee?: StringIterator<any>) => StringNullableChain;
See Also
_.forEach
interface StringNullableChain
interface StringNullableChain {}
method forEachRight
forEachRight: (iteratee?: StringIterator<any>) => StringNullableChain;
See Also
_.forEachRight
interface StringNullableChain
interface StringNullableChain {}
method groupBy
groupBy: (iteratee?: ValueIteratee<string>) => ObjectChain<Dictionary<string[]>>;
See Also
_.groupBy
interface StringNullableChain
interface StringNullableChain {}
method keyBy
keyBy: ( iteratee?: ValueIterateeCustom<string, PropertyName>) => ObjectChain<Dictionary<string>>;
See Also
_.keyBy
interface StringNullableChain
interface StringNullableChain {}
method map
map: { <TResult>(iteratee: StringIterator<TResult>): CollectionChain<TResult>; (): CollectionChain<string>;};
See Also
_.map
interface StringNullableChain
interface StringNullableChain {}
method partition
partition: ( callback: StringIterator<NotVoid>) => LoDashExplicitWrapper<[string[], string[]]>;
See Also
_.partition
interface StringNullableChain
interface StringNullableChain {}
method reject
reject: (predicate?: StringIterator<boolean>) => CollectionChain<string>;
See Also
_.reject
interface StringNullableChain
interface StringNullableChain {}
method sample
sample: () => StringNullableChain;
See Also
_.sample
interface StringNullableChain
interface StringNullableChain {}
method sampleSize
sampleSize: (n?: number) => CollectionChain<string>;
See Also
_.sampleSize
interface StringNullableChain
interface StringNullableChain {}
method shuffle
shuffle: () => CollectionChain<string>;
See Also
_.shuffle
interface StringNullableChain
interface StringNullableChain {}
method castArray
castArray: () => CollectionChain<string | undefined>;
See Also
_.castArray
interface StringNullableChain
interface StringNullableChain {}
method toArray
toArray: () => CollectionChain<string>;
See Also
_.toArray
interface StringNullableChain
interface StringNullableChain {}
method get
get: { (path: number | number[]): StringNullableChain; (path: number | number[], defaultValue: string): StringChain<string>;};
See Also
_.get
interface StringNullableChain
interface StringNullableChain {}
method invertBy
invertBy: ( iteratee?: ValueIteratee<string>) => ObjectChain<Dictionary<string[]>>;
See Also
_.invertBy
interface StringNullableChain
interface StringNullableChain {}
method mapValues
mapValues: { <TResult>(callback: StringIterator<TResult>): ObjectChain< NumericDictionary<TResult> >; (): ObjectChain<NumericDictionary<string>>;};
See Also
_.mapValues
interface StringNullableChain
interface StringNullableChain {}
method values
values: () => CollectionChain<string>;
See Also
_.values
interface StringNullableChain
interface StringNullableChain {}
method valuesIn
valuesIn: () => CollectionChain<string>;
See Also
_.valuesIn
interface StringNullableChain
interface StringNullableChain {}
method iteratee
iteratee: () => FunctionChain<(o: object) => any>;
See Also
_.iteratee
interface TemplateExecutor
interface TemplateExecutor {}
property source
source: string;
See Also
_.source
call signature
(data?: object): string;
interface TemplateOptions
interface TemplateOptions extends TemplateSettings {}
property sourceURL
sourceURL?: string | undefined;
See Also
_.sourceURL
interface TemplateSettings
interface TemplateSettings {}
By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby (ERB). Change the following template settings to use alternative delimiters.
property escape
escape?: RegExp | undefined;
The "escape" delimiter.
property evaluate
evaluate?: RegExp | undefined;
The "evaluate" delimiter.
property imports
imports?: Dictionary<any> | undefined;
An object to import into the template as local variables.
property interpolate
interpolate?: RegExp | undefined;
The "interpolate" delimiter.
property variable
variable?: string | undefined;
Used to reference the data object in the template text.
interface ThrottleSettings
interface ThrottleSettings {}
interface TruncateOptions
interface TruncateOptions {}
Type Aliases
type AnyKindOfDictionary
type AnyKindOfDictionary = Dictionary<unknown> | NumericDictionary<unknown>;
type ArrayIterator
type ArrayIterator<T, TResult> = ( value: T, index: number, collection: T[]) => TResult;
type AssignCustomizer
type AssignCustomizer = ( objectValue: any, sourceValue: any, key?: string, object?: {}, source?: {}) => any;
type CloneDeepWithCustomizer
type CloneDeepWithCustomizer<TObject> = ( value: any, key: number | string | undefined, object: TObject | undefined, stack: any) => any;
type CloneWithCustomizer
type CloneWithCustomizer<TValue, TResult> = ( value: TValue, key: number | string | undefined, object: any, stack: any) => TResult;
type Comparator
type Comparator<T> = (a: T, b: T) => boolean;
type Comparator2
type Comparator2<T1, T2> = (a: T1, b: T2) => boolean;
type CondPairNullary
type CondPairNullary<R> = [() => boolean, () => R];
type CondPairUnary
type CondPairUnary<T, R> = [(val: T) => boolean, (val: T) => R];
type ConformsPredicateObject
type ConformsPredicateObject<T> = { [P in keyof T]: T[P] extends (arg: infer A) => any ? A : any;};
type DictionaryIteratee
type DictionaryIteratee<T> = ObjectIteratee<Dictionary<T>>;
type DictionaryIterator
type DictionaryIterator<T, TResult> = ObjectIterator<Dictionary<T>, TResult>;
type DictionaryIteratorTypeGuard
type DictionaryIteratorTypeGuard<T, S extends T> = ObjectIteratorTypeGuard< Dictionary<T>, S>;
type EmptyObject
type EmptyObject<T> = { [K in keyof T]?: never };
type EmptyObjectOf
type EmptyObjectOf<T> = EmptyObject<T> extends T ? EmptyObject<T> : never;
type ExpChain
type ExpChain<T> = T extends { __trapAny: any } ? CollectionChain<any> & FunctionChain<any> & ObjectChain<any> & PrimitiveChain<any> & StringChain : T extends null | undefined ? never : T extends string ? StringChain<T> : T extends (...args: any) => any ? FunctionChain<T> : T extends List<infer U> | null | undefined ? CollectionChain<U> : T extends object | null | undefined ? ObjectChain<T> : PrimitiveChain<T>;
type Falsey
type Falsey = null | undefined | false | '' | 0 | 0n;
type Flat
type Flat<T> = T extends string ? T : T extends List<any> ? never : T;
type Function0
type Function0<R> = () => R;
type Function1
type Function1<T1, R> = (t1: T1) => R;
type Function2
type Function2<T1, T2, R> = (t1: T1, t2: T2) => R;
type Function3
type Function3<T1, T2, T3, R> = (t1: T1, t2: T2, t3: T3) => R;
type Function4
type Function4<T1, T2, T3, T4, R> = (t1: T1, t2: T2, t3: T3, t4: T4) => R;
type FunctionBase
type FunctionBase = GlobalFunction;
type GetFieldType
type GetFieldType<T, X, XT extends 'DotPath' | 'Key' | 'Path' = 'Path'> = Extract< T, object> extends never ? GetFieldTypeOfPrimitive<T, X, XT> : | GetFieldTypeOfPrimitive<Exclude<T, object>, X, XT> | GetFieldTypeOfObject<Extract<T, object>, X, XT>;
Deduces the type of value at the path P of type T, so that _.get<T, P>(t: T, p: P): GetFieldType<T, P>. XT specifies the exact meaning of X: - 'Path' (default) - X is a path type to be fully parsed; - 'DotPath - X is a dot-delimitered path, without square (indexing) brackets; - 'Key' - X is a simple key, and needs no parsing.
type GetFieldTypeOfArrayLikeByKey
type GetFieldTypeOfArrayLikeByKey<T extends unknown[], K> = K extends number ? T[K] : K extends `${infer N extends number}` ? T[N] : K extends keyof T ? T[K] : undefined;
type GetFieldTypeOfNarrowed
type GetFieldTypeOfNarrowed< T, X, XT extends 'DotPath' | 'Key' | 'Path'> = XT extends 'Key' ? GetFieldTypeOfNarrowedByKey<T, X> : XT extends 'DotPath' ? GetFieldTypeOfNarrowedByDotPath<T, X> : X extends `${infer L}['${infer K}']${infer R}` ? GetFieldTypeOfNarrowedByLKR<T, L, K, R> : X extends `${infer L}["${infer K}"]${infer R}` ? GetFieldTypeOfNarrowedByLKR<T, L, K, R> : X extends `${infer L}[${infer K}]${infer R}` ? GetFieldTypeOfNarrowedByLKR<T, L, K, R> : GetFieldTypeOfNarrowedByDotPath<T, X>;
Internal. Assumes T has been narrowed.
type GetFieldTypeOfNarrowedByDotPath
type GetFieldTypeOfNarrowedByDotPath<T, P> = P extends `${infer L}.${infer R}` ? GetFieldType<GetFieldTypeOfNarrowedByKey<T, L>, R, 'DotPath'> : GetFieldTypeOfNarrowedByKey<T, P>;
Internal. Assumes P is a dot-delimited path.
type GetFieldTypeOfNarrowedByKey
type GetFieldTypeOfNarrowedByKey<T, K> = T extends unknown[] ? GetFieldTypeOfArrayLikeByKey<T, K> : T extends string ? GetFieldTypeOfStringByKey<T, K> : K extends keyof T ? T[K] : K extends number ? `${K}` extends keyof T ? T[`${K}`] : undefined : K extends `${infer N extends number}` ? N extends keyof T ? T[N] : undefined : undefined;
type GetFieldTypeOfNarrowedByLcKR
type GetFieldTypeOfNarrowedByLcKR<T, Lc, K, R> = '' extends R ? GetFieldType<GetFieldTypeOfNarrowedByDotPath<T, Lc>, K, 'Key'> : R extends `.${infer Rc}` ? GetFieldType< GetFieldType<GetFieldTypeOfNarrowedByDotPath<T, Lc>, K, 'Key'>, Rc > : GetFieldType< GetFieldType<GetFieldTypeOfNarrowedByDotPath<T, Lc>, K, 'Key'>, R >;
Internal. This is a piece of GetFieldTypeOfNarrowedByLKR logic, assuming that Lc isn't to be ignored, and does not end with dot.
type GetFieldTypeOfNarrowedByLKR
type GetFieldTypeOfNarrowedByLKR<T, L, K, R> = '' extends L ? '' extends R ? GetFieldTypeOfNarrowedByKey<T, K> : R extends `.${infer Rc}` ? GetFieldType<GetFieldTypeOfNarrowedByKey<T, K>, Rc> : GetFieldType<GetFieldTypeOfNarrowedByKey<T, K>, R> : L extends `${infer Lc}.` ? GetFieldTypeOfNarrowedByLcKR<T, Lc, K, R> : GetFieldTypeOfNarrowedByLcKR<T, L, K, R>;
Internal. Assumes T has been narrowed; L is a dot-delimited path, and should be ignored if an empty string; K is a key name; and R is a dot-delimetered path, to be ignored if an empty string. Also if L has a tail dot, or R has a front dot, these dots should be discarded, however when L or R is just a dot, they should be interpreted as empty key name (rather than ignored).
type GetFieldTypeOfObject
type GetFieldTypeOfObject<T, X, XT extends 'DotPath' | 'Key' | 'Path'> = Extract< T, unknown[]> extends never ? GetFieldTypeOfNarrowed<T, X, XT> : | GetFieldTypeOfNarrowed<Exclude<T, unknown[]>, X, XT> | GetFieldTypeOfNarrowed<Extract<T, unknown[]>, X, XT>;
Internal. Assumes T has been narrowed to an object type.
type GetFieldTypeOfPrimitive
type GetFieldTypeOfPrimitive<T, X, XT extends 'DotPath' | 'Key' | 'Path'> = Extract< T, string> extends never ? T extends never ? never : undefined : | (Exclude<T, string> extends never ? never : undefined) | GetFieldTypeOfNarrowed<Extract<T, string>, X, XT>;
Internal. Assumes T has been narrowed to a primitive type.
type GetFieldTypeOfStringByKey
type GetFieldTypeOfStringByKey<T extends string, K> = K extends number ? T[K] : K extends `${infer N extends number}` ? T[N] : K extends keyof T ? T[K] : undefined;
type ImpChain
type ImpChain<T> = T extends { __trapAny: any } ? Collection<any> & Function<any> & Object<any> & Primitive<any> & String : T extends null | undefined ? never : T extends string ? String<T> : T extends (...args: any) => any ? Function<T> : T extends List<infer U> | null | undefined ? Collection<U> : T extends object | null | undefined ? Object<T> : Primitive<T>;
type IsEqualCustomizer
type IsEqualCustomizer = ( value: any, other: any, indexOrKey: PropertyName | undefined, parent: any, otherParent: any, stack: any) => boolean | undefined;
type isMatchWithCustomizer
type isMatchWithCustomizer = ( value: any, other: any, indexOrKey: PropertyName, object: object, source: object) => boolean | undefined;
type IterateeShorthand
type IterateeShorthand<T> = PropertyName | [PropertyName, any] | PartialShallow<T>;
type List
type List<T> = ArrayLike<T>;
Common interface between Arrays and jQuery objects
type ListIteratee
type ListIteratee<T> = ListIterator<T, NotVoid> | IterateeShorthand<T>;
type ListIterateeCustom
type ListIterateeCustom<T, TResult> = | ListIterator<T, TResult> | IterateeShorthand<T>;
type ListIterator
type ListIterator<T, TResult> = ( value: T, index: number, collection: List<T>) => TResult;
type ListIteratorTypeGuard
type ListIteratorTypeGuard<T, S extends T> = ( value: T, index: number, collection: List<T>) => value is S;
type LoDashExplicitArrayWrapper
type LoDashExplicitArrayWrapper<T> = LoDashExplicitWrapper<T[]>;
type LoDashExplicitNillableArrayWrapper
type LoDashExplicitNillableArrayWrapper<T> = LoDashExplicitWrapper< T[] | null | undefined>;
type LoDashExplicitNillableObjectWrapper
type LoDashExplicitNillableObjectWrapper<T> = LoDashExplicitWrapper< T | null | undefined>;
type LoDashExplicitNumberArrayWrapper
type LoDashExplicitNumberArrayWrapper = LoDashExplicitWrapper<number[]>;
type LoDashExplicitObjectWrapper
type LoDashExplicitObjectWrapper<T> = LoDashExplicitWrapper<T>;
type LoDashExplicitStringWrapper
type LoDashExplicitStringWrapper = LoDashExplicitWrapper<string>;
type LoDashImplicitArrayWrapper
type LoDashImplicitArrayWrapper<T> = LoDashImplicitWrapper<T[]>;
type LoDashImplicitNillableArrayWrapper
type LoDashImplicitNillableArrayWrapper<T> = LoDashImplicitWrapper< T[] | null | undefined>;
type LoDashImplicitNillableObjectWrapper
type LoDashImplicitNillableObjectWrapper<T> = LoDashImplicitWrapper< T | null | undefined>;
type LoDashImplicitNumberArrayWrapper
type LoDashImplicitNumberArrayWrapper = LoDashImplicitWrapper<number[]>;
type LoDashImplicitObjectWrapper
type LoDashImplicitObjectWrapper<T> = LoDashImplicitWrapper<T>;
type LoDashImplicitStringWrapper
type LoDashImplicitStringWrapper = LoDashImplicitWrapper<string>;
type Many
type Many<T> = T | readonly T[];
type MemoIterator
type MemoIterator<T, TResult> = ( prev: TResult, curr: T, indexOrKey: any, list: T[]) => TResult;
Deprecated
Use MemoListIterator or MemoObjectIterator instead.
type MemoIteratorCapped
type MemoIteratorCapped<T, TResult> = (prev: TResult, curr: T) => TResult;
type MemoIteratorCappedRight
type MemoIteratorCappedRight<T, TResult> = (curr: T, prev: TResult) => TResult;
type MemoListIterator
type MemoListIterator<T, TResult, TList> = ( prev: TResult, curr: T, index: number, list: TList) => TResult;
type MemoObjectIterator
type MemoObjectIterator<T, TResult, TList> = ( prev: TResult, curr: T, key: string, list: TList) => TResult;
type MemoVoidArrayIterator
type MemoVoidArrayIterator<T, TResult> = ( acc: TResult, curr: T, index: number, arr: T[]) => void;
type MemoVoidDictionaryIterator
type MemoVoidDictionaryIterator<T, K extends string | number | symbol, TResult> = ( acc: TResult, curr: T, key: K, dict: Record<K, T>) => void;
type MemoVoidIterator
type MemoVoidIterator<T, TResult> = ( prev: TResult, curr: T, indexOrKey: any, list: T[]) => void;
Deprecated
Use MemoVoidArrayIterator or MemoVoidDictionaryIterator instead.
type MemoVoidIteratorCapped
type MemoVoidIteratorCapped<T, TResult> = (acc: TResult, curr: T) => void;
type MergeWithCustomizer
type MergeWithCustomizer = { bivariantHack( value: any, srcValue: any, key: string, object: any, source: any ): any;}['bivariantHack'];
type NotVoid
type NotVoid = unknown;
type NumericDictionaryIteratee
type NumericDictionaryIteratee<T> = | NumericDictionaryIterator<T, NotVoid> | IterateeShorthand<T>;
type NumericDictionaryIterateeCustom
type NumericDictionaryIterateeCustom<T, TResult> = | NumericDictionaryIterator<T, TResult> | IterateeShorthand<T>;
type NumericDictionaryIterator
type NumericDictionaryIterator<T, TResult> = ( value: T, key: string, collection: NumericDictionary<T>) => TResult;
type ObjectIteratee
type ObjectIteratee<TObject> = | ObjectIterator<TObject, NotVoid> | IterateeShorthand<TObject[keyof TObject]>;
type ObjectIterateeCustom
type ObjectIterateeCustom<TObject, TResult> = | ObjectIterator<TObject, TResult> | IterateeShorthand<TObject[keyof TObject]>;
type ObjectIterator
type ObjectIterator<TObject, TResult> = ( value: TObject[keyof TObject], key: string, collection: TObject) => TResult;
type ObjectIteratorTypeGuard
type ObjectIteratorTypeGuard<TObject, S extends TObject[keyof TObject]> = ( value: TObject[keyof TObject], key: string, collection: TObject) => value is S;
type Omit
type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
type PartialObject
type PartialObject<T> = GlobalPartial<T>;
type PartialShallow
type PartialShallow<T> = { [P in keyof T]?: T[P] extends object ? object : T[P];};
type PropertyName
type PropertyName = string | number | symbol;
type PropertyPath
type PropertyPath = Many<PropertyName>;
type ReplaceFunction
type ReplaceFunction = (match: string, ...args: any[]) => string;
type SetWithCustomizer
type SetWithCustomizer<T> = (nsValue: any, key: string, nsObject: T) => any;
type StringIterator
type StringIterator<TResult> = ( char: string, index: number, string: string) => TResult;
type StringToNumber
type StringToNumber<T> = T extends `${infer N extends number}` ? N : never;
type ThrottleSettingsLeading
type ThrottleSettingsLeading = | (ThrottleSettings & { leading: true }) | Omit<ThrottleSettings, 'leading'>;
type Truthy
type Truthy<T> = T extends Falsey ? never : T;
type TupleIterator
type TupleIterator<T extends readonly unknown[], TResult> = ( value: T[number], index: StringToNumber<keyof T>, collection: T) => TResult;
type ValueIteratee
type ValueIteratee<T> = ((value: T) => NotVoid) | IterateeShorthand<T>;
type ValueIterateeCustom
type ValueIterateeCustom<T, TResult> = | ((value: T) => TResult) | IterateeShorthand<T>;
type ValueIteratorTypeGuard
type ValueIteratorTypeGuard<T, S extends T> = (value: T) => value is S;
type ValueKeyIteratee
type ValueKeyIteratee<T> = | ((value: T, key: string) => NotVoid) | IterateeShorthand<T>;
type ValueKeyIterateeTypeGuard
type ValueKeyIterateeTypeGuard<T, S extends T> = ( value: T, key: string) => value is S;
Package Files (13)
Dependencies (0)
No dependencies.
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/lodash
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/lodash)
- HTML<a href="https://www.jsdocs.io/package/@types/lodash"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 26832 ms. - Missing or incorrect documentation? Open an issue for this package.