lodash/index-docs.js

  1. /**
  2.  * @func
  3.  * @memberof module:lodash
  4.  * @name camelCase
  5.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  6.  * @see {@link https://lodash.com/docs/4.17.5#camelCase|_.camelCase}
  7.  */
  8. /**
  9.  * @func
  10.  * @memberof module:lodash
  11.  * @name capitalize
  12.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  13.  * @see {@link https://lodash.com/docs/4.17.5#capitalize|_.capitalize}
  14.  */
  15. /**
  16.  * @func
  17.  * @memberof module:lodash
  18.  * @name castArray
  19.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  20.  * @see {@link https://lodash.com/docs/4.17.5#castArray|_.castArray}
  21.  */
  22. /**
  23.  * @func
  24.  * @memberof module:lodash
  25.  * @name compact
  26.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  27.  * @see {@link https://lodash.com/docs/4.17.5#compact|_.compact}
  28.  */
  29. /**
  30.  * @func
  31.  * @memberof module:lodash
  32.  * @name deburr
  33.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  34.  * @see {@link https://lodash.com/docs/4.17.5#deburr|_.deburr}
  35.  */
  36. /**
  37.  * @func
  38.  * @memberof module:lodash
  39.  * @name escape
  40.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  41.  * @see {@link https://lodash.com/docs/4.17.5#escape|_.escape}
  42.  */
  43. /**
  44.  * @func
  45.  * @memberof module:lodash
  46.  * @name escapeRegExp
  47.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  48.  * @see {@link https://lodash.com/docs/4.17.5#escapeRegExp|_.escapeRegExp}
  49.  */
  50. /**
  51.  * @func
  52.  * @memberof module:lodash
  53.  * @name flip
  54.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  55.  * @see {@link https://lodash.com/docs/4.17.5#flip|_.flip}
  56.  */
  57. /**
  58.  * @func
  59.  * @memberof module:lodash
  60.  * @name forEach
  61.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  62.  * @see {@link https://lodash.com/docs/4.17.5#forEach|_.forEach}
  63.  */
  64. /**
  65.  * @func
  66.  * @memberof module:lodash
  67.  * @name isArrayLike
  68.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  69.  * @see {@link https://lodash.com/docs/4.17.5#isArrayLike|_.isArrayLike}
  70.  */
  71. /**
  72.  * @func
  73.  * @memberof module:lodash
  74.  * @name isNull
  75.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  76.  * @see {@link https://lodash.com/docs/4.17.5#isNull|_.isNull}
  77.  */
  78. /**
  79.  * @func
  80.  * @memberof module:lodash
  81.  * @name isPlainObject
  82.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  83.  * @see {@link https://lodash.com/docs/4.17.5#isPlainObject|_.isPlainObject}
  84.  */
  85. /**
  86.  * @func
  87.  * @memberof module:lodash
  88.  * @name isUndefined
  89.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  90.  * @see {@link https://lodash.com/docs/4.17.5#isUndefined|_.isUndefined}
  91.  */
  92. /**
  93.  * @func
  94.  * @memberof module:lodash
  95.  * @name kebabCase
  96.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  97.  * @see {@link https://lodash.com/docs/4.17.5#kebabCase|_.kebabCase}
  98.  */
  99. /**
  100.  * @func
  101.  * @memberof module:lodash
  102.  * @name keyBy
  103.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  104.  * @see {@link https://lodash.com/docs/4.17.5#keyBy|_.keyBy}
  105.  */
  106. /**
  107.  * @func
  108.  * @memberof module:lodash
  109.  * @name lowerFirst
  110.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  111.  * @see {@link https://lodash.com/docs/4.17.5#lowerFirst|_.lowerFirst}
  112.  */
  113. /**
  114.  * @func
  115.  * @memberof module:lodash
  116.  * @name mapKeys
  117.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  118.  * @see {@link https://lodash.com/docs/4.17.5#mapKeys|_.mapKeys}
  119.  */
  120. /**
  121.  * @func
  122.  * @memberof module:lodash
  123.  * @name noop
  124.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  125.  * @see {@link https://lodash.com/docs/4.17.5#noop|_.noop}
  126.  */
  127. /**
  128.  * @func
  129.  * @memberof module:lodash
  130.  * @name pad
  131.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  132.  * @see {@link https://lodash.com/docs/4.17.5#pad|_.pad}
  133.  */
  134. /**
  135.  * @func
  136.  * @memberof module:lodash
  137.  * @name padChars
  138.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  139.  * @see {@link https://lodash.com/docs/4.17.5#padChars|_.padChars}
  140.  */
  141. /**
  142.  * @func
  143.  * @memberof module:lodash
  144.  * @name padCharsEnd
  145.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  146.  * @see {@link https://lodash.com/docs/4.17.5#padCharsEnd|_.padCharsEnd}
  147.  */
  148. /**
  149.  * @func
  150.  * @memberof module:lodash
  151.  * @name padCharsStart
  152.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  153.  * @see {@link https://lodash.com/docs/4.17.5#padCharsStart|_.padCharsStart}
  154.  */
  155. /**
  156.  * @func
  157.  * @memberof module:lodash
  158.  * @name padEnd
  159.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  160.  * @see {@link https://lodash.com/docs/4.17.5#padEnd|_.padEnd}
  161.  */
  162. /**
  163.  * @func
  164.  * @memberof module:lodash
  165.  * @name padStart
  166.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  167.  * @see {@link https://lodash.com/docs/4.17.5#padStart|_.padStart}
  168.  */
  169. /**
  170.  * @func
  171.  * @memberof module:lodash
  172.  * @name snakeCase
  173.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  174.  * @see {@link https://lodash.com/docs/4.17.5#snakeCase|_.snakeCase}
  175.  */
  176. /**
  177.  * @func
  178.  * @memberof module:lodash
  179.  * @name split
  180.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  181.  * @see {@link https://lodash.com/docs/4.17.5#split|_.split}
  182.  */
  183. /**
  184.  * @func
  185.  * @memberof module:lodash
  186.  * @name startCase
  187.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  188.  * @see {@link https://lodash.com/docs/4.17.5#startCase|_.startCase}
  189.  */
  190. /**
  191.  * @func
  192.  * @memberof module:lodash
  193.  * @name toInteger
  194.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  195.  * @see {@link https://lodash.com/docs/4.17.5#toInteger|_.toInteger}
  196.  */
  197. /**
  198.  * @func
  199.  * @memberof module:lodash
  200.  * @name toLower
  201.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  202.  * @see {@link https://lodash.com/docs/4.17.5#toLower|_.toLower}
  203.  */
  204. /**
  205.  * @func
  206.  * @memberof module:lodash
  207.  * @name toNumber
  208.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  209.  * @see {@link https://lodash.com/docs/4.17.5#toNumber|_.toNumber}
  210.  */
  211. /**
  212.  * @func
  213.  * @memberof module:lodash
  214.  * @name toPlainObject
  215.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  216.  * @see {@link https://lodash.com/docs/4.17.5#toPlainObject|_.toPlainObject}
  217.  */
  218. /**
  219.  * @func
  220.  * @memberof module:lodash
  221.  * @name toString
  222.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  223.  * @see {@link https://lodash.com/docs/4.17.5#toString|_.toString}
  224.  */
  225. /**
  226.  * @func
  227.  * @memberof module:lodash
  228.  * @name toUpper
  229.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  230.  * @see {@link https://lodash.com/docs/4.17.5#toUpper|_.toUpper}
  231.  */
  232. /**
  233.  * @func
  234.  * @memberof module:lodash
  235.  * @name size
  236.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  237.  * @see {@link https://lodash.com/docs/4.17.5#size|_.size}
  238.  */
  239. /**
  240.  * @func
  241.  * @memberof module:lodash
  242.  * @name trim
  243.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  244.  * @see {@link https://lodash.com/docs/4.17.5#trim|_.trim}
  245.  */
  246. /**
  247.  * @func
  248.  * @memberof module:lodash
  249.  * @name trimEnd
  250.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  251.  * @see {@link https://lodash.com/docs/4.17.5#trimEnd|_.trimEnd}
  252.  */
  253. /**
  254.  * @func
  255.  * @memberof module:lodash
  256.  * @name trimStart
  257.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  258.  * @see {@link https://lodash.com/docs/4.17.5#trimStart|_.trimStart}
  259.  */
  260. /**
  261.  * @func
  262.  * @memberof module:lodash
  263.  * @name truncate
  264.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  265.  * @see {@link https://lodash.com/docs/4.17.5#truncate|_.truncate}
  266.  */
  267. /**
  268.  * @func
  269.  * @memberof module:lodash
  270.  * @name unescape
  271.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  272.  * @see {@link https://lodash.com/docs/4.17.5#unescape|_.unescape}
  273.  */
  274. /**
  275.  * @func
  276.  * @memberof module:lodash
  277.  * @name upperFirst
  278.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  279.  * @see {@link https://lodash.com/docs/4.17.5#upperFirst|_.upperFirst}
  280.  */
  281. /**
  282.  * @func
  283.  * @memberof module:lodash
  284.  * @name words
  285.  * @see {@link https://github.com/lodash/lodash/wiki/FP-Guide|FP-Guide For Actual Interface}
  286.  * @see {@link https://lodash.com/docs/4.17.5#words|_.words}
  287.  */