Skip to content

wooorm/html-link-types

Repository files navigation

html-link-types

Build Downloads Size

List of link types as specified by HTML.

Contents

What is this?

This package lists values that are allowed in rel attributes on <a>, <area>, <form>, or <link> elements. These values come from mdn.

When should I use this?

Use this package if you specifically need to check which values are allowed in by the HTML spec in rel attributes on <a>, <area>, <form>, and <link> elements. See link-rel for a list of MicroFormats extensions to <link>, and a-rel for a list of MicroFormats extensions on <a> and <area> elements.

Install

This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:

npm install html-link-types

In Deno with esm.sh:

import {htmlLinkTypes} from 'https://esm.sh/html-link-types@2'

In browsers with esm.sh:

<script type="module">
  import {htmlLinkTypes} from 'https://esm.sh/html-link-types@2?bundle'
</script>

Use

import {htmlLinkTypes} from 'html-link-types'

console.log(htmlLinkTypes)

Yields:

[ 'alternate',
  'archives',
  'author',
  // …
  'stylesheet',
  'tag',
  'up' ]

API

This package exports the identifier htmlLinkTypes. There is no default export.

htmlLinkTypes

List of lowercase types (Array<string>).

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Related

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer