Skip to content

Repository files navigation

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

importprotocolifyfrom'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 URLprotocolify('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.

About

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

Resources

Code of conduct

Contributing

Security policy

Stars

25 stars

Watchers

4 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages