4fd96936aeebd44209d0a6b1d144281c93c66dcae5a4e5a1836948255a7855be89565f7ca46f3a31900bc77d65827d8ea55df5c0bc1be778ee1f5fda3d1873 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405
  1. import _ = require("../index");
  2. declare module "../index" {
  3. interface LoDashStatic {
  4. /**
  5. * Adds two numbers.
  6. *
  7. * @param augend The first number to add.
  8. * @param addend The second number to add.
  9. * @return Returns the sum.
  10. */
  11. add(augend: number, addend: number): number;
  12. }
  13. interface LoDashImplicitWrapper<TValue> {
  14. /**
  15. * @see _.add
  16. */
  17. add(addend: number): number;
  18. }
  19. interface LoDashExplicitWrapper<TValue> {
  20. /**
  21. * @see _.add
  22. */
  23. add(addend: number): PrimitiveChain<number>;
  24. }
  25. interface LoDashStatic {
  26. /**
  27. * Calculates n rounded up to precision.
  28. *
  29. * @param n The number to round up.
  30. * @param precision The precision to round up to.
  31. * @return Returns the rounded up number.
  32. */
  33. ceil(n: number, precision?: number): number;
  34. }
  35. interface LoDashImplicitWrapper<TValue> {
  36. /**
  37. * @see _.ceil
  38. */
  39. ceil(precision?: number): number;
  40. }
  41. interface LoDashExplicitWrapper<TValue> {
  42. /**
  43. * @see _.ceil
  44. */
  45. ceil(precision?: number): PrimitiveChain<number>;
  46. }
  47. interface LoDashStatic {
  48. /**
  49. * Divide two numbers.
  50. *
  51. * @param dividend The first number in a division.
  52. * @param divisor The second number in a division.
  53. * @returns Returns the quotient.
  54. */
  55. divide(dividend: number, divisor: number): number;
  56. }
  57. interface LoDashImplicitWrapper<TValue> {
  58. /**
  59. * @see _.divide
  60. */
  61. divide(divisor: number): number;
  62. }
  63. interface LoDashExplicitWrapper<TValue> {
  64. /**
  65. * @see _.divide
  66. */
  67. divide(divisor: number): PrimitiveChain<number>;
  68. }
  69. interface LoDashStatic {
  70. /**
  71. * Calculates n rounded down to precision.
  72. *
  73. * @param n The number to round down.
  74. * @param precision The precision to round down to.
  75. * @return Returns the rounded down number.
  76. */
  77. floor(n: number, precision?: number): number;
  78. }
  79. interface LoDashImplicitWrapper<TValue> {
  80. /**
  81. * @see _.floor
  82. */
  83. floor(precision?: number): number;
  84. }
  85. interface LoDashExplicitWrapper<TValue> {
  86. /**
  87. * @see _.floor
  88. */
  89. floor(precision?: number): PrimitiveChain<number>;
  90. }
  91. interface LoDashStatic {
  92. /**
  93. * Computes the maximum value of `array`. If `array` is empty or falsey
  94. * `undefined` is returned.
  95. *
  96. * @category Math
  97. * @param array The array to iterate over.
  98. * @returns Returns the maximum value.
  99. */
  100. max<T>(collection: List<T> | null | undefined): T | undefined;
  101. }
  102. interface Collection<T> {
  103. /**
  104. * @see _.max
  105. */
  106. max(): T | undefined;
  107. }
  108. interface CollectionChain<T> {
  109. /**
  110. * @see _.max
  111. */
  112. max(): ExpChain<T | undefined>;
  113. }
  114. interface LoDashStatic {
  115. /**
  116. * This method is like `_.max` except that it accepts `iteratee` which is
  117. * invoked for each element in `array` to generate the criterion by which
  118. * the value is ranked. The iteratee is invoked with one argument: (value).
  119. *
  120. * @category Math
  121. * @param array The array to iterate over.
  122. * @param iteratee The iteratee invoked per element.
  123. * @returns Returns the maximum value.
  124. * @example
  125. *
  126. * var objects = [{ 'n': 1 }, { 'n': 2 }];
  127. *
  128. * _.maxBy(objects, function(o) { return o.n; });
  129. * // => { 'n': 2 }
  130. *
  131. * // using the `_.property` iteratee shorthand
  132. * _.maxBy(objects, 'n');
  133. * // => { 'n': 2 }
  134. */
  135. maxBy<T>(collection: List<T> | null | undefined, iteratee?: ValueIteratee<T>): T | undefined;
  136. }
  137. interface Collection<T> {
  138. /**
  139. * @see _.maxBy
  140. */
  141. maxBy(iteratee?: ValueIteratee<T>): T | undefined;
  142. }
  143. interface CollectionChain<T> {
  144. /**
  145. * @see _.maxBy
  146. */
  147. maxBy(iteratee?: ValueIteratee<T>): ExpChain<T | undefined>;
  148. }
  149. interface LoDashStatic {
  150. /**
  151. * Computes the mean of the values in `array`.
  152. *
  153. * @category Math
  154. * @param array The array to iterate over.
  155. * @returns Returns the mean.
  156. * @example
  157. *
  158. * _.mean([4, 2, 8, 6]);
  159. * // => 5
  160. */
  161. mean(collection: List<any> | null | undefined): number;
  162. }
  163. interface LoDashImplicitWrapper<TValue> {
  164. /**
  165. * @see _.mean
  166. */
  167. mean(): number;
  168. }
  169. interface LoDashExplicitWrapper<TValue> {
  170. /**
  171. * @see _.mean
  172. */
  173. mean(): PrimitiveChain<number>;
  174. }
  175. interface LoDashStatic {
  176. /**
  177. * Computes the mean of the provided properties of the objects in the `array`
  178. *
  179. * @category Math
  180. * @param array The array to iterate over.
  181. * @param iteratee The iteratee invoked per element.
  182. * @returns Returns the mean.
  183. * @example
  184. *
  185. * _.mean([{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }], 'n');
  186. * // => 5
  187. */
  188. meanBy<T>(collection: List<T> | null | undefined, iteratee?: ValueIteratee<T>): number;
  189. }
  190. interface Collection<T> {
  191. /**
  192. * @see _.meanBy
  193. */
  194. meanBy(iteratee?: ValueIteratee<T>): number;
  195. }
  196. interface CollectionChain<T> {
  197. /**
  198. * @see _.meanBy
  199. */
  200. meanBy(iteratee?: ValueIteratee<T>): PrimitiveChain<number>;
  201. }
  202. interface LoDashStatic {
  203. /**
  204. * Computes the minimum value of `array`. If `array` is empty or falsey
  205. * `undefined` is returned.
  206. *
  207. * @category Math
  208. * @param array The array to iterate over.
  209. * @returns Returns the minimum value.
  210. */
  211. min<T>(collection: List<T> | null | undefined): T | undefined;
  212. }
  213. interface Collection<T> {
  214. /**
  215. * @see _.min
  216. */
  217. min(): T | undefined;
  218. }
  219. interface CollectionChain<T> {
  220. /**
  221. * @see _.min
  222. */
  223. min(): ExpChain<T | undefined>;
  224. }
  225. interface LoDashStatic {
  226. /**
  227. * This method is like `_.min` except that it accepts `iteratee` which is
  228. * invoked for each element in `array` to generate the criterion by which
  229. * the value is ranked. The iteratee is invoked with one argument: (value).
  230. *
  231. * @category Math
  232. * @param array The array to iterate over.
  233. * @param iteratee The iteratee invoked per element.
  234. * @returns Returns the minimum value.
  235. * @example
  236. *
  237. * var objects = [{ 'n': 1 }, { 'n': 2 }];
  238. *
  239. * _.minBy(objects, function(o) { return o.a; });
  240. * // => { 'n': 1 }
  241. *
  242. * // using the `_.property` iteratee shorthand
  243. * _.minBy(objects, 'n');
  244. * // => { 'n': 1 }
  245. */
  246. minBy<T>(collection: List<T> | null | undefined, iteratee?: ValueIteratee<T>): T | undefined;
  247. }
  248. interface Collection<T> {
  249. /**
  250. * @see _.minBy
  251. */
  252. minBy(iteratee?: ValueIteratee<T>): T | undefined;
  253. }
  254. interface CollectionChain<T> {
  255. /**
  256. * @see _.minBy
  257. */
  258. minBy(iteratee?: ValueIteratee<T>): ExpChain<T | undefined>;
  259. }
  260. interface LoDashStatic {
  261. /**
  262. * Multiply two numbers.
  263. * @param multiplier The first number in a multiplication.
  264. * @param multiplicand The second number in a multiplication.
  265. * @returns Returns the product.
  266. */
  267. multiply(multiplier: number, multiplicand: number): number;
  268. }
  269. interface LoDashImplicitWrapper<TValue> {
  270. /**
  271. * @see _.multiply
  272. */
  273. multiply(multiplicand: number): number;
  274. }
  275. interface LoDashExplicitWrapper<TValue> {
  276. /**
  277. * @see _.multiply
  278. */
  279. multiply(multiplicand: number): PrimitiveChain<number>;
  280. }
  281. interface LoDashStatic {
  282. /**
  283. * Calculates n rounded to precision.
  284. *
  285. * @param n The number to round.
  286. * @param precision The precision to round to.
  287. * @return Returns the rounded number.
  288. */
  289. round(n: number, precision?: number): number;
  290. }
  291. interface LoDashImplicitWrapper<TValue> {
  292. /**
  293. * @see _.round
  294. */
  295. round(precision?: number): number;
  296. }
  297. interface LoDashExplicitWrapper<TValue> {
  298. /**
  299. * @see _.round
  300. */
  301. round(precision?: number): PrimitiveChain<number>;
  302. }
  303. interface LoDashStatic {
  304. /**
  305. * Subtract two numbers.
  306. *
  307. * @category Math
  308. * @param minuend The first number in a subtraction.
  309. * @param subtrahend The second number in a subtraction.
  310. * @returns Returns the difference.
  311. * @example
  312. *
  313. * _.subtract(6, 4);
  314. * // => 2
  315. */
  316. subtract(minuend: number, subtrahend: number): number;
  317. }
  318. interface LoDashImplicitWrapper<TValue> {
  319. /**
  320. * @see _.subtract
  321. */
  322. subtract(subtrahend: number): number;
  323. }
  324. interface LoDashExplicitWrapper<TValue> {
  325. /**
  326. * @see _.subtract
  327. */
  328. subtract(subtrahend: number): PrimitiveChain<number>;
  329. }
  330. interface LoDashStatic {
  331. /**
  332. * Computes the sum of the values in `array`.
  333. *
  334. * @category Math
  335. * @param array The array to iterate over.
  336. * @returns Returns the sum.
  337. * @example
  338. *
  339. * _.sum([4, 2, 8, 6]);
  340. * // => 20
  341. */
  342. sum(collection: List<any> | null | undefined): number;
  343. }
  344. interface LoDashImplicitWrapper<TValue> {
  345. /**
  346. * @see _.sum
  347. */
  348. sum(): number;
  349. }
  350. interface LoDashExplicitWrapper<TValue> {
  351. /**
  352. * @see _.sum
  353. */
  354. sum(): PrimitiveChain<number>;
  355. }
  356. interface LoDashStatic {
  357. /**
  358. * This method is like `_.sum` except that it accepts `iteratee` which is
  359. * invoked for each element in `array` to generate the value to be summed.
  360. * The iteratee is invoked with one argument: (value).
  361. *
  362. * @category Math
  363. * @param array The array to iterate over.
  364. * @param [iteratee=_.identity] The iteratee invoked per element.
  365. * @returns Returns the sum.
  366. * @example
  367. *
  368. * var objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }];
  369. *
  370. * _.sumBy(objects, function(o) { return o.n; });
  371. * // => 20
  372. *
  373. * // using the `_.property` iteratee shorthand
  374. * _.sumBy(objects, 'n');
  375. * // => 20
  376. */
  377. sumBy<T>(collection: List<T> | null | undefined, iteratee?: ((value: T) => number) | string): number;
  378. }
  379. interface Collection<T> {
  380. /**
  381. * @see _.sumBy
  382. */
  383. sumBy(iteratee?: ((value: T) => number) | string): number;
  384. }
  385. interface CollectionChain<T> {
  386. /**
  387. * @see _.sumBy
  388. */
  389. sumBy(iteratee?: ((value: T) => number) | string): PrimitiveChain<number>;
  390. }
  391. }