Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rubensworks/relative-to-absolute-iri.js
Resolve relative IRIs to absolute IRIs given a base IRI
https://github.com/rubensworks/relative-to-absolute-iri.js
absolute base hacktoberfest iri relative resolve uri
Last synced: 2 months ago
JSON representation
Resolve relative IRIs to absolute IRIs given a base IRI
- Host: GitHub
- URL: https://github.com/rubensworks/relative-to-absolute-iri.js
- Owner: rubensworks
- License: mit
- Created: 2018-10-31T14:22:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-20T12:34:58.000Z (3 months ago)
- Last Synced: 2024-10-15T07:08:51.815Z (3 months ago)
- Topics: absolute, base, hacktoberfest, iri, relative, resolve, uri
- Language: TypeScript
- Homepage:
- Size: 293 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Relative to Absolute IRI
[](https://github.com/rubensworks/relative-to-absolute-iri.js/actions?query=workflow%3ACI)
[](https://coveralls.io/github/rubensworks/relative-to-absolute-iri.js?branch=master)
[](https://www.npmjs.com/package/relative-to-absolute-iri)
Resolve relative IRIs to absolute IRIs given a base IRI,
conforming to [RFC3986](https://www.ietf.org/rfc/rfc3986.txt).
## Installation
```bash
$ yarn install relative-to-absolute-iri
```
This package also works out-of-the-box in browsers via tools such as [webpack](https://webpack.js.org/) and [browserify](http://browserify.org/).
## Require
```javascript
import {resolve} from "relative-to-absolute-iri";
```
_or_
```javascript
const resolve = require("relative-to-absolute-iri").resolve;
```
## Usage
### Parameters
This library exposes a single `resolve` function
that must be called with a relative IRI (string) as first argument,
and an optional base IRI (string) as second argument.
It will output an absolute IRI (string).
```javascript
resolve('relative', 'http://base.org/'); // Outputs 'http://base.org/relative'
```
### Relative IRIs
IRIs that are already relative will remain relative:
```javascript
resolve('http://example.org/'); // Outputs 'http://example.org/'
resolve('http://example.org/', 'http://base.org/'); // Outputs 'http://example.org/'
```
### Hashes
Fragments/hashes in relative IRIs are also taken into account.
```javascript
resolve('#abc', 'http://base.org/'); // Outputs 'http://base.org/#abc'
```
### Invalid base IRI
Invalid base IRIs cause an error to be thrown.
```javascript
resolve('abc', 'def'); // Error
```
### Relative to scheme
When a relative IRI starts with a `//`, then the scheme of the base IRI will be used.
```javascript
resolve('//abc', 'http://base.org/'); // Outputs 'http://abc'
```
### Absolute relative IRIs
Relative IRIs that starts with a `/` erase the path of the base IRI.
```javascript
resolve('/abc/def/', 'http://base.org/123/456/'); // Outputs 'http://base.org/abc/def/'
```
### Collapsing of dots
Relative IRIs that point to the current directory (`.`)
or parent directory (`..`) are collapsed.
```javascript
resolve('xyz', 'http://aa/parent/parent/../../a'); // Outputs 'http://aa/xyz'
resolve('xyz', 'http://aa/././a'); // Outputs 'http://aa/xyz'
```
## License
This software is written by [Ruben Taelman](http://rubensworks.net/).
This code is released under the [MIT license](http://opensource.org/licenses/MIT).