273 lines
6.2 KiB
Markdown
273 lines
6.2 KiB
Markdown
|
<!-- 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 help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
|
||
|
|
||
|
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
> Get the protocols of an input url.
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
## :cloud: Installation
|
||
|
|
||
|
```sh
|
||
|
# Using npm
|
||
|
npm install --save protocols
|
||
|
|
||
|
# Using yarn
|
||
|
yarn add 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|URL** `input`: The input url (string or `URL` instance)
|
||
|
- **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 to 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:
|
||
|
|
||
|
- `parse-url`
|
||
|
- `parse-path`
|
||
|
- `is-ssh`
|
||
|
- `@enkeledi/react-native-week-month-date-picker`
|
||
|
- `bb-parse-url`
|
||
|
- `@hemith/react-native-tnk`
|
||
|
- `miguelcostero-ng2-toasty`
|
||
|
- `native-kakao-login`
|
||
|
- `react-native-my-first-try-arun-ramya`
|
||
|
- `react-native-kakao-maps`
|
||
|
- `react-native-is7`
|
||
|
- `react-native-ytximkit`
|
||
|
- `react-native-payu-payment-testing`
|
||
|
- `npm_one_1_2_3`
|
||
|
- `react-native-biometric-authenticate`
|
||
|
- `react-native-arunmeena1987`
|
||
|
- `react-native-contact-list`
|
||
|
- `rn-adyen-dropin`
|
||
|
- `@positionex/position-sdk`
|
||
|
- `@corelmax/react-native-my2c2p-sdk`
|
||
|
- `@felipesimmi/react-native-datalogic-module`
|
||
|
- `@hawkingnetwork/react-native-tab-view`
|
||
|
- `react-native-cplus`
|
||
|
- `npm_qwerty`
|
||
|
- `native-apple-login`
|
||
|
- `drowl-base-theme-iconset`
|
||
|
- `react-native-arunjeyam1987`
|
||
|
- `react-native-bubble-chart`
|
||
|
- `react-native-flyy`
|
||
|
- `@apardellass/react-native-audio-stream`
|
||
|
- `@geeky-apo/react-native-advanced-clipboard`
|
||
|
- `candlelabssdk`
|
||
|
- `@saad27/react-native-bottom-tab-tour`
|
||
|
- `generator-bootstrap-boilerplate-template`
|
||
|
- `react-feedback-sdk`
|
||
|
- `npm_one_12_34_1_`
|
||
|
- `npm_one_2_2`
|
||
|
- `payutesting`
|
||
|
- `react-native-dsphoto-module`
|
||
|
- `react-native-sayhello-module`
|
||
|
- `react-native-responsive-size`
|
||
|
- `@con-test/react-native-concent-common`
|
||
|
- `luojia-cli-dev`
|
||
|
- `birken-react-native-community-image-editor`
|
||
|
- `reac-native-arun-ramya-test`
|
||
|
- `react-native-arun-ramya-test`
|
||
|
- `react-native-arunramya151`
|
||
|
- `react-native-pulsator-native`
|
||
|
- `react-native-plugpag-wrapper`
|
||
|
- `react-native-transtracker-library`
|
||
|
- `@screeb/react-native`
|
||
|
- `@buganto/client`
|
||
|
- `astra-ufo-sdk`
|
||
|
- `angularvezba`
|
||
|
- `react-native-syan-photo-picker`
|
||
|
- `@wecraftapps/react-native-use-keyboard`
|
||
|
- `l2forlerna`
|
||
|
- `native-google-login`
|
||
|
- `raact-native-arunramya151`
|
||
|
- `react-native-modal-progress-bar`
|
||
|
- `react-native-test-module-hhh`
|
||
|
- `react-native-jsi-device-info`
|
||
|
- `react-native-badge-control`
|
||
|
- `rn-tm-notify`
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
## :scroll: License
|
||
|
|
||
|
[MIT][license] © [Ionică Bizău][website]
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
[license]: /LICENSE
|
||
|
[website]: https://ionicabizau.net
|
||
|
[contributing]: /CONTRIBUTING.md
|
||
|
[docs]: /DOCUMENTATION.md
|
||
|
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
|
||
|
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
|
||
|
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
|
||
|
[badge_paypal_donate]: https://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
|