Get origin from url string in Node.js
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
.gitignore
.travis.yml
LICENSE
README.md
package.json
tsconfig.json

README.md

get-url-origin Build Status

Get origin from url string in Node.js.

This library based on Node.js's Legacy URL API(require('url').Url)

If you can use Node.js >=7, please use New built-in URL module.

Install

Install with npm:

npm install get-url-origin

Usage

API

/**
 * Return URL origin string from `urlString`.
 * If origin is not found, return null
 * @param {string} urlString
 * @returns {string | null}
 * @see https://url.spec.whatwg.org/#origin
 */
export declare const getURLOrigin: (urlString: string) => string | null;

Example

import { getURLOrigin } from "get-url-origin";
getURLOrigin('https://example.com/file/to/path?example'); // => 'https://example.com'
getURLOrigin('http://example.com:80/path/to/file'); // => 'http://example.com:80'

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu