protocolify
TypeScript icon, indicating that this package has built-in type declarations

4.0.0 • Public • Published

protocolify

Prepend https:// to humanized URLs like sindresorhus.com and file:// to file paths

Useful when you want to accept either a local file or URL as argument in your CLI app.

Install

$ npm install protocolify

Usage

import protocolify from 'protocolify';

protocolify('sindresorhus.com');
//=> 'https://sindresorhus.com'

protocolify('localhost', {https: false});
//=> 'http://localhost'

protocolify('https://sindresorhus.com');
//=> 'https://sindresorhus.com'

// If it exists on disk, it will be interpreted as a file and not a URL
protocolify('index.js');
//=> 'file:///Users/sindresorhus/dev/protocolify/index.js'

API

protocolify(urlOrFilePath, options?)

urlOrFilePath

Type: string

The URL to prepend https:// or file path to prepend file://.

options

Type: object

https

Type: boolean
Default: true

Prepend https:// instead of http:// to URLs.

Package Sidebar

Install

npm i protocolify

Weekly Downloads

36,736

Version

4.0.0

License

MIT

Unpacked Size

4.13 kB

Total Files

5

Last publish

Collaborators

  • sindresorhus