# schemes

> IANA Uniform Resource Identifier (URI) Schemes list, including crowd sourced unofficial ones

Latest version **1.4.0** (published 2021-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install schemes
pnpm add schemes
yarn add schemes
bun add schemes
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2021-08-09 |
| First published | 2015-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 50.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Peter Müller |
| Maintainers | munter |
| Keywords | iana, uri, url, scheme, schemes, protocol, protocols, rfc |

## Links

- npm: https://www.npmjs.com/package/schemes
- Repository: https://github.com/Munter/schemes
- Issues: https://github.com/Munter/schemes/issues
- npm.io page: https://npm.io/package/schemes

## Dependencies (1)

- [extend](https://npm.io/package/extend.md) ^3.0.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.4.0 (latest) — 2021-08-09
- 1.3.0 — 2021-06-09
- 1.2.0 — 2021-03-18
- 1.1.1 — 2016-05-05
- 1.1.0 — 2016-03-29
- 1.0.1 — 2015-04-08
- 1.0.0 — 2015-04-05

## README

Schemes
=======

[![NPM version](https://badge.fury.io/js/schemes.svg)](http://badge.fury.io/js/schemes)
[![Build Status](https://travis-ci.org/Munter/schemes.svg?branch=master)](https://travis-ci.org/Munter/schemes)
[![Coverage Status](https://img.shields.io/coveralls/Munter/schemes.svg)](https://coveralls.io/r/Munter/schemes?branch=master)
[![Dependency Status](https://david-dm.org/Munter/schemes.svg)](https://david-dm.org/Munter/schemes)

A javascript object map of official [iana.org Uniform Resource Identifier (URI) Schemes](http://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml) and crowd sourced unofficial schemes.

This can be used to look up the rfc's for the corresponding schemes or check a schemes validity based on of it exists in the list of not.

Usage
-----
```javascript
var schemes = require('schemes');

schemes.permanent[0]; // {
                      //   "scheme": "aaa",
                      //   "description": "Diameter Protocol",
                      //   "reference": [
                      //     {
                      //       "type": "rfc",
                      //       "href": "http://www.iana.org/go/rfc6733"
                      //     }
                      //   ]
                      // }

schemes.provisional[0]; // {
                        //   "scheme": "acr",
                        //   "description": "acr",
                        //   "reference": [],
                        //   "template": "http://www.iana.org/assignments/uri-schemes/prov/acr"
                        // }

schemes.historical[0]; // {
                       //   "scheme": "fax",
                       //   "description": "fax",
                       //   "reference": [
                       //     {
                       //       "type": "rfc",
                       //       "href": "http://www.iana.org/go/rfc2806"
                       //     },
                       //     {
                       //       "type": "rfc",
                       //       "href": "http://www.iana.org/go/rfc3966"
                       //     }
                       //   ]
                       // }

schemes.unofficial[0]; // {
                       //   "scheme": "android-app"
                       // }

schemes.allByName; // {
                   //   'aaa': { ... } // scheme object
                   //   'aaas': { ... } // scheme object
                   //   'about': { ... } // scheme object
                   //   'acap': { ... } // scheme object
                   //   'acct': { ... } // scheme object
                   //   'cap': { ... } // scheme object
                   //   'cid': { ... } // scheme object
                   //   'coap': { ... } // scheme object
                   //   'coaps': { ... } // scheme object
                   //   'crid': { ... } // scheme object
                   //   ...
                   // }
```

Contributing
------------

Part of this module is auto generated from iana official lists, but the unofficial ones are not. If you find that a specific scheme is missing from these lists, please submit a pull request that adds it to the [unofficial schemes list](https://github.com/Munter/schemes/blob/master/lib/unofficial.json).


License
-------
(The MIT License)

Copyright (c) 2015 Peter Müller <munter@fumle.dk>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---
_Source: https://npm.io/package/schemes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
