Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

filenamify-url

sindresorhus435.2kMIT3.1.0TypeScript support: included

Convert a URL to a valid filename

filename, file, name, string, path, convert, valid, url

readme

filenamify-url

Convert a URL to a valid filename

Install

npm install filenamify-url

Usage

import filenamifyUrl from 'filenamify-url';

filenamifyUrl('http://sindresorhus.com/foo?bar=baz');
//=> 'sindresorhus.com!foo!bar=baz'

filenamifyUrl('http://sindresorhus.com/foo', {replacement: '🐴'});
//=> 'sindresorhus.com🐴foo'

filenamifyUrl(new URL('http://sindresorhus.com'));
//=> 'sindresorhus.com'

API

filenamifyUrl(url, options?)

Accepts a URL and returns a valid filename.

url

Type: string | URL

A URL to convert to a valid filename.

options

Type: object

See the filenamify options.