Layout von Websiten mit Bootstrap und Foundation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 7.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. # fill-range [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8YFZ425KND68) [![NPM version](https://img.shields.io/npm/v/fill-range.svg?style=flat)](https://www.npmjs.com/package/fill-range) [![NPM monthly downloads](https://img.shields.io/npm/dm/fill-range.svg?style=flat)](https://npmjs.org/package/fill-range) [![NPM total downloads](https://img.shields.io/npm/dt/fill-range.svg?style=flat)](https://npmjs.org/package/fill-range) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/fill-range.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/fill-range)
  2. > Fill in a range of numbers or letters, optionally passing an increment or `step` to use, or create a regex-compatible range with `options.toRegex`
  3. Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
  4. ## Install
  5. Install with [npm](https://www.npmjs.com/):
  6. ```sh
  7. $ npm install --save fill-range
  8. ```
  9. ## Usage
  10. Expands numbers and letters, optionally using a `step` as the last argument. _(Numbers may be defined as JavaScript numbers or strings)_.
  11. ```js
  12. const fill = require('fill-range');
  13. // fill(from, to[, step, options]);
  14. console.log(fill('1', '10')); //=> ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10']
  15. console.log(fill('1', '10', { toRegex: true })); //=> [1-9]|10
  16. ```
  17. **Params**
  18. * `from`: **{String|Number}** the number or letter to start with
  19. * `to`: **{String|Number}** the number or letter to end with
  20. * `step`: **{String|Number|Object|Function}** Optionally pass a [step](#optionsstep) to use.
  21. * `options`: **{Object|Function}**: See all available [options](#options)
  22. ## Examples
  23. By default, an array of values is returned.
  24. **Alphabetical ranges**
  25. ```js
  26. console.log(fill('a', 'e')); //=> ['a', 'b', 'c', 'd', 'e']
  27. console.log(fill('A', 'E')); //=> [ 'A', 'B', 'C', 'D', 'E' ]
  28. ```
  29. **Numerical ranges**
  30. Numbers can be defined as actual numbers or strings.
  31. ```js
  32. console.log(fill(1, 5)); //=> [ 1, 2, 3, 4, 5 ]
  33. console.log(fill('1', '5')); //=> [ 1, 2, 3, 4, 5 ]
  34. ```
  35. **Negative ranges**
  36. Numbers can be defined as actual numbers or strings.
  37. ```js
  38. console.log(fill('-5', '-1')); //=> [ '-5', '-4', '-3', '-2', '-1' ]
  39. console.log(fill('-5', '5')); //=> [ '-5', '-4', '-3', '-2', '-1', '0', '1', '2', '3', '4', '5' ]
  40. ```
  41. **Steps (increments)**
  42. ```js
  43. // numerical ranges with increments
  44. console.log(fill('0', '25', 4)); //=> [ '0', '4', '8', '12', '16', '20', '24' ]
  45. console.log(fill('0', '25', 5)); //=> [ '0', '5', '10', '15', '20', '25' ]
  46. console.log(fill('0', '25', 6)); //=> [ '0', '6', '12', '18', '24' ]
  47. // alphabetical ranges with increments
  48. console.log(fill('a', 'z', 4)); //=> [ 'a', 'e', 'i', 'm', 'q', 'u', 'y' ]
  49. console.log(fill('a', 'z', 5)); //=> [ 'a', 'f', 'k', 'p', 'u', 'z' ]
  50. console.log(fill('a', 'z', 6)); //=> [ 'a', 'g', 'm', 's', 'y' ]
  51. ```
  52. ## Options
  53. ### options.step
  54. **Type**: `number` (formatted as a string or number)
  55. **Default**: `undefined`
  56. **Description**: The increment to use for the range. Can be used with letters or numbers.
  57. **Example(s)**
  58. ```js
  59. // numbers
  60. console.log(fill('1', '10', 2)); //=> [ '1', '3', '5', '7', '9' ]
  61. console.log(fill('1', '10', 3)); //=> [ '1', '4', '7', '10' ]
  62. console.log(fill('1', '10', 4)); //=> [ '1', '5', '9' ]
  63. // letters
  64. console.log(fill('a', 'z', 5)); //=> [ 'a', 'f', 'k', 'p', 'u', 'z' ]
  65. console.log(fill('a', 'z', 7)); //=> [ 'a', 'h', 'o', 'v' ]
  66. console.log(fill('a', 'z', 9)); //=> [ 'a', 'j', 's' ]
  67. ```
  68. ### options.strictRanges
  69. **Type**: `boolean`
  70. **Default**: `false`
  71. **Description**: By default, `null` is returned when an invalid range is passed. Enable this option to throw a `RangeError` on invalid ranges.
  72. **Example(s)**
  73. The following are all invalid:
  74. ```js
  75. fill('1.1', '2'); // decimals not supported in ranges
  76. fill('a', '2'); // incompatible range values
  77. fill(1, 10, 'foo'); // invalid "step" argument
  78. ```
  79. ### options.stringify
  80. **Type**: `boolean`
  81. **Default**: `undefined`
  82. **Description**: Cast all returned values to strings. By default, integers are returned as numbers.
  83. **Example(s)**
  84. ```js
  85. console.log(fill(1, 5)); //=> [ 1, 2, 3, 4, 5 ]
  86. console.log(fill(1, 5, { stringify: true })); //=> [ '1', '2', '3', '4', '5' ]
  87. ```
  88. ### options.toRegex
  89. **Type**: `boolean`
  90. **Default**: `undefined`
  91. **Description**: Create a regex-compatible source string, instead of expanding values to an array.
  92. **Example(s)**
  93. ```js
  94. // alphabetical range
  95. console.log(fill('a', 'e', { toRegex: true })); //=> '[a-e]'
  96. // alphabetical with step
  97. console.log(fill('a', 'z', 3, { toRegex: true })); //=> 'a|d|g|j|m|p|s|v|y'
  98. // numerical range
  99. console.log(fill('1', '100', { toRegex: true })); //=> '[1-9]|[1-9][0-9]|100'
  100. // numerical range with zero padding
  101. console.log(fill('000001', '100000', { toRegex: true }));
  102. //=> '0{5}[1-9]|0{4}[1-9][0-9]|0{3}[1-9][0-9]{2}|0{2}[1-9][0-9]{3}|0[1-9][0-9]{4}|100000'
  103. ```
  104. ### options.transform
  105. **Type**: `function`
  106. **Default**: `undefined`
  107. **Description**: Customize each value in the returned array (or [string](#optionstoRegex)). _(you can also pass this function as the last argument to `fill()`)_.
  108. **Example(s)**
  109. ```js
  110. // add zero padding
  111. console.log(fill(1, 5, value => String(value).padStart(4, '0')));
  112. //=> ['0001', '0002', '0003', '0004', '0005']
  113. ```
  114. ## About
  115. <details>
  116. <summary><strong>Contributing</strong></summary>
  117. Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  118. </details>
  119. <details>
  120. <summary><strong>Running Tests</strong></summary>
  121. Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
  122. ```sh
  123. $ npm install && npm test
  124. ```
  125. </details>
  126. <details>
  127. <summary><strong>Building docs</strong></summary>
  128. _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
  129. To generate the readme, run the following command:
  130. ```sh
  131. $ npm install -g verbose/verb#dev verb-generate-readme && verb
  132. ```
  133. </details>
  134. ### Contributors
  135. | **Commits** | **Contributor** |
  136. | --- | --- |
  137. | 116 | [jonschlinkert](https://github.com/jonschlinkert) |
  138. | 4 | [paulmillr](https://github.com/paulmillr) |
  139. | 2 | [realityking](https://github.com/realityking) |
  140. | 2 | [bluelovers](https://github.com/bluelovers) |
  141. | 1 | [edorivai](https://github.com/edorivai) |
  142. | 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) |
  143. ### Author
  144. **Jon Schlinkert**
  145. * [GitHub Profile](https://github.com/jonschlinkert)
  146. * [Twitter Profile](https://twitter.com/jonschlinkert)
  147. * [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
  148. Please consider supporting me on Patreon, or [start your own Patreon page](https://patreon.com/invite/bxpbvm)!
  149. <a href="https://www.patreon.com/jonschlinkert">
  150. <img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" height="50">
  151. </a>
  152. ### License
  153. Copyright © 2019, [Jon Schlinkert](https://github.com/jonschlinkert).
  154. Released under the [MIT License](LICENSE).
  155. ***
  156. _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 08, 2019._