@mapbox/link-to-location

Convert a link (HTMLAnchorElement or URL) to an abbreviated Location object.

Stats

StarsIssuesVersionUpdatedCreatedSize
@mapbox/link-to-location
1.0.04 years ago4 years agoMinified + gzip package size for @mapbox/link-to-location in KB

Readme

@mapbox/link-to-location

Convert a link (HTMLAnchorElement or URL) to an object with pathname, hash, and search properties. Uses the browser's native link parsing to avoid unnecessary code.

Installation

npm install @mapbox/link-to-location

API

linkToLocation

linkToLocation(input)

Returns an object with three properties with string values: pathname, hash, and search.

input

Type: HTMLAnchorElement | string.

Either the DOM element itself or a URL.

Example

const linkToLocation = require('link-to-location');

linkToLocation('http://user:pw@foo.bar.baz/qux?quux=grault#fred');
/*
  {
    pathname: 'foo.bar.baz/qux',
    hash: '#fred',
    search: '?quux=grault'
  }
*/

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.