README.md

detect-external-link

JavaScript plugin that analyzes the given link and determines if the URL is internal or external. To ensure accuracy, please include a list of specified hosts that should be marked as internal. This way, the plugin can effectively differentiate between internal and external links based on the provided hosts list.

Install

Via npm

npm install detect-external-link

Via Yarn

yarn add detect-external-link

For vanilla HTML in modern browsers, import detect-external-link from jsDelivr:

<script type="module">
import detectExternalLink from 'https://cdn.jsdelivr.net/npm/detect-external-link@2/+esm';

console.log(detectExternalLink('http://test.example2.com/test/abc/', {
  'hosts': [
    'http://example.com',
    'http://test.example.com'
  ]
}));
</script>

Usage

import detectExternalLink from '/js/index.js';

const link = 'http://test.example2.com/test/abc/';
const linkOptions = {
  'hosts': [
    'http://example.com',
    'http://test.example.com'
  ]
};

console.log(detectExternalLink(link, linkOptions));

Parameters

Attributes	Type	Required	Default	Description
hosts	Array	Yes	[]	Site hostname(s) to detect external links.