linkify-main

The main module exposed in the npm package @bartificer/linkify. This module exposes the public interface, but does not implement any functionality.

To understand the link generation functionality, the appropraite entry point into the code is the module:linkifier-class.Linkifier class.

Description:

  • The main module exposed in the npm package @bartificer/linkify. This module exposes the public interface, but does not implement any functionality.

    To understand the link generation functionality, the appropraite entry point into the code is the module:linkifier-class.Linkifier class.

Source:
See:
Example

Basic Usage

import { linkify } from '@bartificer/linkify';

(async () => {
   console.log(await linkify.generateLink('https://github.com/bartificer'));
   // Output: <a href="https://github.com/bartificer" title="Bartificer Creations · GitHub">Bartificer Creations · GitHub</a>
})();

Requires

Members

(static) LinkData :module:link-data.LinkData

Description:

  • The data representation class capturing the information about a link, for example its title and URL.

Source:

The data representation class capturing the information about a link, for example its title and URL.

Type:

(static) LinkTemplate :module:link-template.LinkTemplate

Description:

  • The class capturing the details of a template used to render links.

Source:

The class capturing the details of a template used to render links.

Type:

(static) Linkifier :module:linkifier-class.Linkifier

Description:

  • The Linkifier class that provides the core link generation functionality.

Source:

The Linkifier class that provides the core link generation functionality.

Type:

(static) PageData :module:page-data.PageData

Description:

  • The data representation class capturing the information extracted from a web page, for example the page's title and headings.

Source:

The data representation class capturing the information extracted from a web page, for example the page's title and headings.

Type:

(static, constant) VERSION :string

Description:

  • The module's current SEMVER version number.

Source:
See:

The module's current SEMVER version number.

Type:
  • string

(static, constant) default :module:linkifier-class.Linkifier

Description:

  • The default export, equivalent to the linkify named export.

Source:
See:
  • module:linkify.linkify

The default export, equivalent to the linkify named export.

Type:

(static, constant) linkify :module:linkifier-class.Linkifier

Description:

  • An instantiated Linkifier object ready for use with the default settings as generated with the defauly constructor.

Source:

An instantiated Linkifier object ready for use with the default settings as generated with the defauly constructor.

Type: