mirror of https://github.com/owncast/owncast.git synced 2024-11-27 17:59:21 +03:00

History

Owncast a88734348a Commit updated Javascript packages		2020-10-20 05:04:18 +00:00
..
.github/workflows	Commit updated Javascript packages	2020-10-20 05:04:18 +00:00
src	Commit updated Javascript packages	2020-10-20 05:04:18 +00:00
test	Commit updated Javascript packages	2020-10-20 05:04:18 +00:00
.prettierrc	Commit updated Javascript packages	2020-10-20 05:04:18 +00:00
jest.config.js	Commit updated Javascript packages	2020-10-20 05:04:18 +00:00
LICENSE	Commit updated Javascript packages	2020-10-20 05:04:18 +00:00
package.json	Commit updated Javascript packages	2020-10-20 05:04:18 +00:00
README.md	Commit updated Javascript packages	2020-10-20 05:04:18 +00:00

README.md

URL Toolkit

Lightweight library to build an absolute URL from a base URL and a relative URL, written from the spec (RFC 1808). Initially part of HLS.JS.

Methods

`buildAbsoluteURL(baseURL, relativeURL, opts={})`

Build an absolute URL from a relative and base one.

URLToolkit.buildAbsoluteURL('http://a.com/b/cd', 'e/f/../g'); // => http://a.com/b/e/g

If you want to ensure that the URL is treated as a relative one you should prefix it with ./.

URLToolkit.buildAbsoluteURL('http://a.com/b/cd', 'a:b'); // => a:b
URLToolkit.buildAbsoluteURL('http://a.com/b/cd', './a:b'); // => http://a.com/b/a:b

By default the paths will not be normalized unless necessary, according to the spec. However you can ensure paths are always normalized by setting the opts.alwaysNormalize option to true.

URLToolkit.buildAbsoluteURL('http://a.com/b/cd', '/e/f/../g'); // => http://a.com/e/f/../g
URLToolkit.buildAbsoluteURL('http://a.com/b/cd', '/e/f/../g', {
  alwaysNormalize: true,
}); // => http://a.com/e/g

`normalizePath(url)`

Normalizes a path.

URLToolkit.normalizePath('a/b/../c'); // => a/c

`parseURL(url)`

Parse a URL into its separate components.

URLToolkit.parseURL('http://a/b/c/d;p?q#f'); // =>
/* {
	scheme: 'http:',
	netLoc: '//a',
	path: '/b/c/d',
	params: ';p',
	query: '?q',
	fragment: '#f'
} */

`buildURLFromParts(parts)`

Puts all the parts from parseURL() back together into a string.

Example

var URLToolkit = require('url-toolkit');
var url = URLToolkit.buildAbsoluteURL(
  'https://a.com/b/cd/e.m3u8?test=1#something',
  '../z.ts?abc=1#test'
);
console.log(url); // 'https://a.com/b/z.ts?abc=1#test'

Browser

This can also be used in the browser thanks to jsDelivr:

<head>
  <script
    type="text/javascript"
    src="https://cdn.jsdelivr.net/npm/url-toolkit@2"
  ></script>
  <script type="text/javascript">
    var url = URLToolkit.buildAbsoluteURL(
      'https://a.com/b/cd/e.m3u8?test=1#something',
      '../z.ts?abc=1#test'
    );
    console.log(url); // 'https://a.com/b/z.ts?abc=1#test'
  </script>
</head>