Awesome
link-rel
List of valid values for rel
on <link>
.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Contribute
- Security
- License
What is this?
This package is a list of specified and common values of rel
attributes on
link
elements.
The list comes from the HTML spec and MicroFormats.
When should I use this?
You can use this package to check if a certain value is valid value of a rel
attribute on a link
element.
Alternatively, you can use html-link-types
for just the
specced values.
Install
This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:
npm install link-rel
In Deno with esm.sh
:
import {linkRel} from 'https://esm.sh/link-rel@2'
In browsers with esm.sh
:
<script type="module">
import {linkRel} from 'https://esm.sh/link-rel@2?bundle'
</script>
Use
import {linkRel} from 'link-rel'
console.log(linkRel.length) //=> 112
console.log(linkRel.slice(0, 10))
Yields:
[
'DCTERMS.conformsTo',
'DCTERMS.contributor',
'DCTERMS.creator',
'DCTERMS.description',
'DCTERMS.hasFormat',
'DCTERMS.hasPart',
'DCTERMS.hasVersion',
'DCTERMS.isFormatOf',
'DCTERMS.isPartOf',
'DCTERMS.isReferencedBy'
]
API
This package exports the identifier linkRel
.
There is no default export.
linkRel
List of valid values for rel
on <link>
(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.
Contribute
Yes please! See How to Contribute to Open Source.
Security
This package is safe.