|
|
- <!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
-
-
- # protocols
-
- [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Travis](https://img.shields.io/travis/IonicaBizau/protocols.svg)](https://travis-ci.org/IonicaBizau/protocols/) [![Version](https://img.shields.io/npm/v/protocols.svg)](https://www.npmjs.com/package/protocols) [![Downloads](https://img.shields.io/npm/dt/protocols.svg)](https://www.npmjs.com/package/protocols)
-
- > Get the protocols of an input url.
-
- ## :cloud: Installation
-
- ```sh
- $ npm i --save protocols
- ```
-
-
- ## :clipboard: Example
-
-
-
- ```js
- // Dependencies
- const protocols = require("protocols");
-
- console.log(protocols("git+ssh://git@some-host.com/and-the-path/name"));
- // ["git", "ssh"]
-
- console.log(protocols("http://ionicabizau.net", true));
- // "http"
- ```
-
-
-
- ## :question: Get Help
-
- There are few ways to get help:
-
- 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
- 2. For bug reports and feature requests, open issues. :bug:
- 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
-
-
- ## :memo: Documentation
-
-
- ### `protocols(input, first)`
- Returns the protocols of an input url.
-
- #### Params
-
- - **String** `input`: The input url.
- - **Boolean|Number** `first`: If `true`, the first protocol will be returned. If number, it will represent the zero-based index of the protocols array.
-
- #### Return
- - **Array|String** The array of protocols or the specified protocol.
-
-
-
- ## :yum: How to contribute
- Have an idea? Found a bug? See [how to contribute][contributing].
-
-
- ## :sparkling_heart: Support my projects
-
- I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously,
- this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
-
- However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
-
- - Starring and sharing the projects you like :rocket:
- - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
-
- ![](https://i.imgur.com/z6OQI95.png)
-
- Thanks! :heart:
-
-
- ## :dizzy: Where is this library used?
- If you are using this library in one of your projects, add it in this list. :sparkles:
-
-
- - [`bb-parse-url`](https://github.com/IonicaBizau/parse-url)—An advanced url parser supporting git urls too.
- - [`is-ssh`](https://github.com/IonicaBizau/node-is-ssh)—Check if an input value is a ssh url or not.
- - [`parse-path`](https://github.com/IonicaBizau/parse-path)—Parse paths (local paths, urls: ssh/git/etc)
- - [`parse-url`](https://github.com/IonicaBizau/parse-url)—An advanced url parser supporting git urls too.
-
- ## :scroll: License
-
- [MIT][license] © [Ionică Bizău][website]
-
- [badge_patreon]: http://ionicabizau.github.io/badges/patreon.svg
- [badge_amazon]: http://ionicabizau.github.io/badges/amazon.svg
- [badge_paypal]: http://ionicabizau.github.io/badges/paypal.svg
- [badge_paypal_donate]: http://ionicabizau.github.io/badges/paypal_donate.svg
- [patreon]: https://www.patreon.com/ionicabizau
- [amazon]: http://amzn.eu/hRo9sIZ
- [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
- [donate-now]: http://i.imgur.com/6cMbHOC.png
-
- [license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
- [website]: https://ionicabizau.net
- [contributing]: /CONTRIBUTING.md
- [docs]: /DOCUMENTATION.md
|