{\bfseries{Contributing}}

\begin{quote}
Fill in a range of numbers or letters, optionally passing an increment or {\ttfamily step} to use, or create a regex-\/compatible range with {\ttfamily options.\+to\+Regex} \end{quote}
Please consider following this project\textquotesingle{}s author, \href{https://github.com/jonschlinkert}{\texttt{ Jon Schlinkert}}, and consider starring the project to show your \+:heart\+: and support.\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10538}{}\doxysection{Install}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10538}
Install with \href{https://www.npmjs.com/}{\texttt{ npm}}\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{\$ npm install -\/-\/save fill-\/range }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10539}{}\doxysection{Usage}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10539}
Expands numbers and letters, optionally using a {\ttfamily step} as the last argument. \+\_\+(\+Numbers may be defined as Java\+Script numbers or strings)\+\_\+.


\begin{DoxyCode}{0}
\DoxyCodeLine{const fill = require('fill-\/range');}
\DoxyCodeLine{// fill(from, to[, step, options]);}
\DoxyCodeLine{}
\DoxyCodeLine{console.log(fill('1', '10')); //=> ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10']}
\DoxyCodeLine{console.log(fill('1', '10', \{ toRegex: true \})); //=> [1-\/9]|10 }

\end{DoxyCode}


{\bfseries{Params}}


\begin{DoxyItemize}
\item {\ttfamily from}\+: $\ast$$\ast$\{String$\vert$\+Number\}$\ast$$\ast$ the number or letter to start with
\item {\ttfamily to}\+: $\ast$$\ast$\{String$\vert$\+Number\}$\ast$$\ast$ the number or letter to end with
\item {\ttfamily step}\+: $\ast$$\ast$\{String$\vert$\+Number$\vert$\+Object$\vert$\+Function\}$\ast$$\ast$ Optionally pass a \href{\#optionsstep}{\texttt{ step}} to use.
\item {\ttfamily options}\+: $\ast$$\ast$\{Object$\vert$\+Function\}$\ast$$\ast$\+: See all available \href{\#options}{\texttt{ options}}
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10540}{}\doxysection{Examples}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10540}
By default, an array of values is returned.

{\bfseries{Alphabetical ranges}}


\begin{DoxyCode}{0}
\DoxyCodeLine{console.log(fill('a', 'e')); //=> ['a', 'b', 'c', 'd', 'e']}
\DoxyCodeLine{console.log(fill('A', 'E')); //=> [ 'A', 'B', 'C', 'D', 'E' ] }

\end{DoxyCode}


{\bfseries{Numerical ranges}}

Numbers can be defined as actual numbers or strings.


\begin{DoxyCode}{0}
\DoxyCodeLine{console.log(fill(1, 5));     //=> [ 1, 2, 3, 4, 5 ]}
\DoxyCodeLine{console.log(fill('1', '5')); //=> [ 1, 2, 3, 4, 5 ] }

\end{DoxyCode}


{\bfseries{Negative ranges}}

Numbers can be defined as actual numbers or strings.


\begin{DoxyCode}{0}
\DoxyCodeLine{console.log(fill('-\/5', '-\/1')); //=> [ '-\/5', '-\/4', '-\/3', '-\/2', '-\/1' ]}
\DoxyCodeLine{console.log(fill('-\/5', '5')); //=> [ '-\/5', '-\/4', '-\/3', '-\/2', '-\/1', '0', '1', '2', '3', '4', '5' ] }

\end{DoxyCode}


{\bfseries{Steps (increments)}}


\begin{DoxyCode}{0}
\DoxyCodeLine{// numerical ranges with increments}
\DoxyCodeLine{console.log(fill('0', '25', 4)); //=> [ '0', '4', '8', '12', '16', '20', '24' ]}
\DoxyCodeLine{console.log(fill('0', '25', 5)); //=> [ '0', '5', '10', '15', '20', '25' ]}
\DoxyCodeLine{console.log(fill('0', '25', 6)); //=> [ '0', '6', '12', '18', '24' ]}
\DoxyCodeLine{}
\DoxyCodeLine{// alphabetical ranges with increments}
\DoxyCodeLine{console.log(fill('a', 'z', 4)); //=> [ 'a', 'e', 'i', 'm', 'q', 'u', 'y' ]}
\DoxyCodeLine{console.log(fill('a', 'z', 5)); //=> [ 'a', 'f', 'k', 'p', 'u', 'z' ]}
\DoxyCodeLine{console.log(fill('a', 'z', 6)); //=> [ 'a', 'g', 'm', 's', 'y' ] }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10541}{}\doxysection{Options}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10541}
\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10542}{}\doxysubsection{options.\+step}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10542}
{\bfseries{Type}}\+: {\ttfamily number} (formatted as a string or number)

{\bfseries{Default}}\+: {\ttfamily undefined}

{\bfseries{Description}}\+: The increment to use for the range. Can be used with letters or numbers.

{\bfseries{Example(s)}}


\begin{DoxyCode}{0}
\DoxyCodeLine{// numbers}
\DoxyCodeLine{console.log(fill('1', '10', 2)); //=> [ '1', '3', '5', '7', '9' ]}
\DoxyCodeLine{console.log(fill('1', '10', 3)); //=> [ '1', '4', '7', '10' ]}
\DoxyCodeLine{console.log(fill('1', '10', 4)); //=> [ '1', '5', '9' ]}
\DoxyCodeLine{}
\DoxyCodeLine{// letters}
\DoxyCodeLine{console.log(fill('a', 'z', 5)); //=> [ 'a', 'f', 'k', 'p', 'u', 'z' ]}
\DoxyCodeLine{console.log(fill('a', 'z', 7)); //=> [ 'a', 'h', 'o', 'v' ]}
\DoxyCodeLine{console.log(fill('a', 'z', 9)); //=> [ 'a', 'j', 's' ] }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10543}{}\doxysubsection{options.\+strict\+Ranges}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10543}
{\bfseries{Type}}\+: {\ttfamily boolean}

{\bfseries{Default}}\+: {\ttfamily false}

{\bfseries{Description}}\+: By default, {\ttfamily null} is returned when an invalid range is passed. Enable this option to throw a {\ttfamily Range\+Error} on invalid ranges.

{\bfseries{Example(s)}}

The following are all invalid\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{fill('1.1', '2');   // decimals not supported in ranges}
\DoxyCodeLine{fill('a', '2');     // incompatible range values}
\DoxyCodeLine{fill(1, 10, 'foo'); // invalid "{}step"{} argument }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10544}{}\doxysubsection{options.\+stringify}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10544}
{\bfseries{Type}}\+: {\ttfamily boolean}

{\bfseries{Default}}\+: {\ttfamily undefined}

{\bfseries{Description}}\+: Cast all returned values to strings. By default, integers are returned as numbers.

{\bfseries{Example(s)}}


\begin{DoxyCode}{0}
\DoxyCodeLine{console.log(fill(1, 5));                    //=> [ 1, 2, 3, 4, 5 ]}
\DoxyCodeLine{console.log(fill(1, 5, \{ stringify: true \})); //=> [ '1', '2', '3', '4', '5' ] }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10545}{}\doxysubsection{options.\+to\+Regex}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10545}
{\bfseries{Type}}\+: {\ttfamily boolean}

{\bfseries{Default}}\+: {\ttfamily undefined}

{\bfseries{Description}}\+: Create a regex-\/compatible source string, instead of expanding values to an array.

{\bfseries{Example(s)}}


\begin{DoxyCode}{0}
\DoxyCodeLine{// alphabetical range}
\DoxyCodeLine{console.log(fill('a', 'e', \{ toRegex: true \})); //=> '[a-\/e]'}
\DoxyCodeLine{// alphabetical with step}
\DoxyCodeLine{console.log(fill('a', 'z', 3, \{ toRegex: true \})); //=> 'a|d|g|j|m|p|s|v|y'}
\DoxyCodeLine{// numerical range}
\DoxyCodeLine{console.log(fill('1', '100', \{ toRegex: true \})); //=> '[1-\/9]|[1-\/9][0-\/9]|100'}
\DoxyCodeLine{// numerical range with zero padding}
\DoxyCodeLine{console.log(fill('000001', '100000', \{ toRegex: true \}));}
\DoxyCodeLine{//=> '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' }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10546}{}\doxysubsection{options.\+transform}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10546}
{\bfseries{Type}}\+: {\ttfamily function}

{\bfseries{Default}}\+: {\ttfamily undefined}

{\bfseries{Description}}\+: Customize each value in the returned array (or \href{\#optionstoRegex}{\texttt{ string}}). \+\_\+(you can also pass this function as the last argument to {\ttfamily fill()})\+\_\+.

{\bfseries{Example(s)}}


\begin{DoxyCode}{0}
\DoxyCodeLine{// add zero padding}
\DoxyCodeLine{console.log(fill(1, 5, value => String(value).padStart(4, '0')));}
\DoxyCodeLine{//=> ['0001', '0002', '0003', '0004', '0005'] }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10547}{}\doxysection{About}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10547}
$<$details$>$

Pull requests and stars are always welcome. For bugs and feature requests, \href{../../issues/new}{\texttt{ please create an issue}}.

$<$/details$>$

$<$details$>$

{\bfseries{Running Tests}} 

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\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{\$ npm install \&\& npm test }

\end{DoxyCode}


$<$/details$>$

$<$details$>$

{\bfseries{Building docs}} 

\+\_\+(This project\textquotesingle{}s readme.\+md is generated by \href{https://github.com/verbose/verb-generate-readme}{\texttt{ verb}}, please don\textquotesingle{}t edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)\+\_\+

To generate the readme, run the following command\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{\$ npm install -\/g verbose/verb\#dev verb-\/generate-\/readme \&\& verb }

\end{DoxyCode}


$<$/details$>$\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10548}{}\doxysubsection{Contributors}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10548}
\tabulinesep=1mm
\begin{longtabu}spread 0pt [c]{*{2}{|X[-1]}|}
\hline
\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ {\bfseries{Commits}}   }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ {\bfseries{Contributor}}    }\\\cline{1-2}
\endfirsthead
\hline
\endfoot
\hline
\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ {\bfseries{Commits}}   }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ {\bfseries{Contributor}}    }\\\cline{1-2}
\endhead
116   &\href{https://github.com/jonschlinkert}{\texttt{ jonschlinkert}}    \\\cline{1-2}
4   &\href{https://github.com/paulmillr}{\texttt{ paulmillr}}    \\\cline{1-2}
2   &\href{https://github.com/realityking}{\texttt{ realityking}}    \\\cline{1-2}
2   &\href{https://github.com/bluelovers}{\texttt{ bluelovers}}    \\\cline{1-2}
1   &\href{https://github.com/edorivai}{\texttt{ edorivai}}    \\\cline{1-2}
1   &\href{https://github.com/wtgtybhertgeghgtwtg}{\texttt{ wtgtybhertgeghgtwtg}}   \\\cline{1-2}
\end{longtabu}
\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10549}{}\doxysubsection{Author}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10549}
{\bfseries{Jon Schlinkert}}


\begin{DoxyItemize}
\item \href{https://github.com/jonschlinkert}{\texttt{ Git\+Hub Profile}}
\item \href{https://twitter.com/jonschlinkert}{\texttt{ Twitter Profile}}
\item \href{https://linkedin.com/in/jonschlinkert}{\texttt{ Linked\+In Profile}}
\end{DoxyItemize}

Please consider supporting me on Patreon, or \href{https://patreon.com/invite/bxpbvm}{\texttt{ start your own Patreon page}}!

\href{https://www.patreon.com/jonschlinkert}{\texttt{  }}\hypertarget{md_sfcode_node_modules_fill_range_README_autotoc_md10550}{}\doxysubsection{License}\label{md_sfcode_node_modules_fill_range_README_autotoc_md10550}
Copyright © 2019, \href{https://github.com/jonschlinkert}{\texttt{ Jon Schlinkert}}. Released under the \mbox{[}MIT License\mbox{]}(LICENSE).

\DoxyHorRuler{0}


{\itshape This file was generated by \href{https://github.com/verbose/verb-generate-readme}{\texttt{ verb-\/generate-\/readme}}, v0.\+8.\+0, on April 08, 2019.} 