\begin{quote}
Convert a string to a valid safe filename \end{quote}
On Unix-\/like systems {\ttfamily /} is reserved and \href{http://msdn.microsoft.com/en-us/library/aa365247\%28VS.85\%29\#naming_conventions}{\texttt{ {\ttfamily $<$$>$\+:"{}/\textbackslash{}$\vert$?$\ast$}}} on Windows.\hypertarget{md_sfcode_node_modules_filenamify_readme_autotoc_md10522}{}\doxysection{Install}\label{md_sfcode_node_modules_filenamify_readme_autotoc_md10522}

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

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_filenamify_readme_autotoc_md10523}{}\doxysection{Usage}\label{md_sfcode_node_modules_filenamify_readme_autotoc_md10523}

\begin{DoxyCode}{0}
\DoxyCodeLine{const filenamify = require('filenamify');}
\DoxyCodeLine{}
\DoxyCodeLine{filenamify('<foo/bar>');}
\DoxyCodeLine{//=> 'foo!bar'}
\DoxyCodeLine{}
\DoxyCodeLine{filenamify('foo:"{}bar"{}', \{replacement: '🐴'\});}
\DoxyCodeLine{//=> 'foo🐴bar' }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_filenamify_readme_autotoc_md10524}{}\doxysection{API}\label{md_sfcode_node_modules_filenamify_readme_autotoc_md10524}
\hypertarget{md_sfcode_node_modules_filenamify_readme_autotoc_md10525}{}\doxysubsection{filenamify(input, \mbox{[}options\mbox{]})}\label{md_sfcode_node_modules_filenamify_readme_autotoc_md10525}
Accepts a filename and returns a valid filename.\hypertarget{md_sfcode_node_modules_filenamify_readme_autotoc_md10526}{}\doxysubsection{filenamify.\+path(input, \mbox{[}options\mbox{]})}\label{md_sfcode_node_modules_filenamify_readme_autotoc_md10526}
Accepts a path and returns the path with a valid filename.\hypertarget{md_sfcode_node_modules_filenamify_readme_autotoc_md10527}{}\doxysubsubsection{input}\label{md_sfcode_node_modules_filenamify_readme_autotoc_md10527}
Type\+: {\ttfamily string}\hypertarget{md_sfcode_node_modules_filenamify_readme_autotoc_md10528}{}\doxysubsubsection{options}\label{md_sfcode_node_modules_filenamify_readme_autotoc_md10528}
\hypertarget{md_sfcode_node_modules_filenamify_readme_autotoc_md10529}{}\doxyparagraph{replacement}\label{md_sfcode_node_modules_filenamify_readme_autotoc_md10529}
Type\+: {\ttfamily string}~\newline
 Default\+: `'!\textquotesingle{}\`{}

String to use as replacement for reserved filename characters.

Cannot contain\+: {\ttfamily $<$} {\ttfamily $>$} {\ttfamily \+:} {\ttfamily "{}} {\ttfamily /} {\ttfamily \textbackslash{}} {\ttfamily $\vert$} {\ttfamily ?} {\ttfamily $\ast$}\hypertarget{md_sfcode_node_modules_filenamify_readme_autotoc_md10530}{}\doxysection{Related}\label{md_sfcode_node_modules_filenamify_readme_autotoc_md10530}

\begin{DoxyItemize}
\item \href{https://github.com/sindresorhus/filenamify-url}{\texttt{ filenamify-\/url}} -\/ Convert a URL to a valid filename
\item \href{https://github.com/sindresorhus/valid-filename}{\texttt{ valid-\/filename}} -\/ Check if a string is a valid filename
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_filenamify_readme_autotoc_md10531}{}\doxysection{License}\label{md_sfcode_node_modules_filenamify_readme_autotoc_md10531}
MIT © \href{https://sindresorhus.com}{\texttt{ Sindre Sorhus}} 