Refactor routing in App component to enhance navigation and improve error handling by integrating dynamic routes and updating the NotFound route.
This commit is contained in:
4
node_modules/hast-util-is-element/index.d.ts
generated
vendored
Normal file
4
node_modules/hast-util-is-element/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
export type Check = import('./lib/index.js').Check;
|
||||
export type Test = import('./lib/index.js').Test;
|
||||
export type TestFunction = import('./lib/index.js').TestFunction;
|
||||
export { convertElement, isElement } from "./lib/index.js";
|
7
node_modules/hast-util-is-element/index.js
generated
vendored
Normal file
7
node_modules/hast-util-is-element/index.js
generated
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
/**
|
||||
* @typedef {import('./lib/index.js').Check} Check
|
||||
* @typedef {import('./lib/index.js').Test} Test
|
||||
* @typedef {import('./lib/index.js').TestFunction} TestFunction
|
||||
*/
|
||||
|
||||
export {convertElement, isElement} from './lib/index.js'
|
103
node_modules/hast-util-is-element/lib/index.d.ts
generated
vendored
Normal file
103
node_modules/hast-util-is-element/lib/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,103 @@
|
||||
/**
|
||||
* @typedef {import('hast').Element} Element
|
||||
* @typedef {import('hast').Parents} Parents
|
||||
*/
|
||||
/**
|
||||
* @template Fn
|
||||
* @template Fallback
|
||||
* @typedef {Fn extends (value: any) => value is infer Thing ? Thing : Fallback} Predicate
|
||||
*/
|
||||
/**
|
||||
* @callback Check
|
||||
* Check that an arbitrary value is an element.
|
||||
* @param {unknown} this
|
||||
* Context object (`this`) to call `test` with
|
||||
* @param {unknown} [element]
|
||||
* Anything (typically a node).
|
||||
* @param {number | null | undefined} [index]
|
||||
* Position of `element` in its parent.
|
||||
* @param {Parents | null | undefined} [parent]
|
||||
* Parent of `element`.
|
||||
* @returns {boolean}
|
||||
* Whether this is an element and passes a test.
|
||||
*
|
||||
* @typedef {Array<TestFunction | string> | TestFunction | string | null | undefined} Test
|
||||
* Check for an arbitrary element.
|
||||
*
|
||||
* * when `string`, checks that the element has that tag name
|
||||
* * when `function`, see `TestFunction`
|
||||
* * when `Array`, checks if one of the subtests pass
|
||||
*
|
||||
* @callback TestFunction
|
||||
* Check if an element passes a test.
|
||||
* @param {unknown} this
|
||||
* The given context.
|
||||
* @param {Element} element
|
||||
* An element.
|
||||
* @param {number | undefined} [index]
|
||||
* Position of `element` in its parent.
|
||||
* @param {Parents | undefined} [parent]
|
||||
* Parent of `element`.
|
||||
* @returns {boolean | undefined | void}
|
||||
* Whether this element passes the test.
|
||||
*
|
||||
* Note: `void` is included until TS sees no return as `undefined`.
|
||||
*/
|
||||
/**
|
||||
* Check if `element` is an `Element` and whether it passes the given test.
|
||||
*
|
||||
* @param element
|
||||
* Thing to check, typically `element`.
|
||||
* @param test
|
||||
* Check for a specific element.
|
||||
* @param index
|
||||
* Position of `element` in its parent.
|
||||
* @param parent
|
||||
* Parent of `element`.
|
||||
* @param context
|
||||
* Context object (`this`) to call `test` with.
|
||||
* @returns
|
||||
* Whether `element` is an `Element` and passes a test.
|
||||
* @throws
|
||||
* When an incorrect `test`, `index`, or `parent` is given; there is no error
|
||||
* thrown when `element` is not a node or not an element.
|
||||
*/
|
||||
export const isElement: (<Condition extends TestFunction>(element: unknown, test: Condition, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is import("hast").Element & Predicate<Condition, import("hast").Element>) & (<Condition_1 extends string>(element: unknown, test: Condition_1, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is import("hast").Element & {
|
||||
tagName: Condition_1;
|
||||
}) & ((element?: null | undefined) => false) & ((element: unknown, test?: null | undefined, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is import("hast").Element) & ((element: unknown, test?: Test, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => boolean);
|
||||
/**
|
||||
* Generate a check from a test.
|
||||
*
|
||||
* Useful if you’re going to test many nodes, for example when creating a
|
||||
* utility where something else passes a compatible test.
|
||||
*
|
||||
* The created function is a bit faster because it expects valid input only:
|
||||
* an `element`, `index`, and `parent`.
|
||||
*
|
||||
* @param test
|
||||
* A test for a specific element.
|
||||
* @returns
|
||||
* A check.
|
||||
*/
|
||||
export const convertElement: (<Condition extends TestFunction>(test: Condition) => (element: unknown, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is import("hast").Element & Predicate<Condition, import("hast").Element>) & (<Condition_1 extends string>(test: Condition_1) => (element: unknown, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is import("hast").Element & {
|
||||
tagName: Condition_1;
|
||||
}) & ((test?: null | undefined) => (element?: unknown, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is import("hast").Element) & ((test?: Test) => Check);
|
||||
export type Element = import('hast').Element;
|
||||
export type Parents = import('hast').Parents;
|
||||
export type Predicate<Fn, Fallback> = Fn extends (value: any) => value is infer Thing ? Thing : Fallback;
|
||||
/**
|
||||
* Check that an arbitrary value is an element.
|
||||
*/
|
||||
export type Check = (this: unknown, element?: unknown, index?: number | null | undefined, parent?: Parents | null | undefined) => boolean;
|
||||
/**
|
||||
* Check for an arbitrary element.
|
||||
*
|
||||
* * when `string`, checks that the element has that tag name
|
||||
* * when `function`, see `TestFunction`
|
||||
* * when `Array`, checks if one of the subtests pass
|
||||
*/
|
||||
export type Test = Array<TestFunction | string> | TestFunction | string | null | undefined;
|
||||
/**
|
||||
* Check if an element passes a test.
|
||||
*/
|
||||
export type TestFunction = (this: unknown, element: Element, index?: number | undefined, parent?: Parents | undefined) => boolean | undefined | void;
|
278
node_modules/hast-util-is-element/lib/index.js
generated
vendored
Normal file
278
node_modules/hast-util-is-element/lib/index.js
generated
vendored
Normal file
@@ -0,0 +1,278 @@
|
||||
/**
|
||||
* @typedef {import('hast').Element} Element
|
||||
* @typedef {import('hast').Parents} Parents
|
||||
*/
|
||||
|
||||
/**
|
||||
* @template Fn
|
||||
* @template Fallback
|
||||
* @typedef {Fn extends (value: any) => value is infer Thing ? Thing : Fallback} Predicate
|
||||
*/
|
||||
|
||||
/**
|
||||
* @callback Check
|
||||
* Check that an arbitrary value is an element.
|
||||
* @param {unknown} this
|
||||
* Context object (`this`) to call `test` with
|
||||
* @param {unknown} [element]
|
||||
* Anything (typically a node).
|
||||
* @param {number | null | undefined} [index]
|
||||
* Position of `element` in its parent.
|
||||
* @param {Parents | null | undefined} [parent]
|
||||
* Parent of `element`.
|
||||
* @returns {boolean}
|
||||
* Whether this is an element and passes a test.
|
||||
*
|
||||
* @typedef {Array<TestFunction | string> | TestFunction | string | null | undefined} Test
|
||||
* Check for an arbitrary element.
|
||||
*
|
||||
* * when `string`, checks that the element has that tag name
|
||||
* * when `function`, see `TestFunction`
|
||||
* * when `Array`, checks if one of the subtests pass
|
||||
*
|
||||
* @callback TestFunction
|
||||
* Check if an element passes a test.
|
||||
* @param {unknown} this
|
||||
* The given context.
|
||||
* @param {Element} element
|
||||
* An element.
|
||||
* @param {number | undefined} [index]
|
||||
* Position of `element` in its parent.
|
||||
* @param {Parents | undefined} [parent]
|
||||
* Parent of `element`.
|
||||
* @returns {boolean | undefined | void}
|
||||
* Whether this element passes the test.
|
||||
*
|
||||
* Note: `void` is included until TS sees no return as `undefined`.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Check if `element` is an `Element` and whether it passes the given test.
|
||||
*
|
||||
* @param element
|
||||
* Thing to check, typically `element`.
|
||||
* @param test
|
||||
* Check for a specific element.
|
||||
* @param index
|
||||
* Position of `element` in its parent.
|
||||
* @param parent
|
||||
* Parent of `element`.
|
||||
* @param context
|
||||
* Context object (`this`) to call `test` with.
|
||||
* @returns
|
||||
* Whether `element` is an `Element` and passes a test.
|
||||
* @throws
|
||||
* When an incorrect `test`, `index`, or `parent` is given; there is no error
|
||||
* thrown when `element` is not a node or not an element.
|
||||
*/
|
||||
export const isElement =
|
||||
// Note: overloads in JSDoc can’t yet use different `@template`s.
|
||||
/**
|
||||
* @type {(
|
||||
* (<Condition extends TestFunction>(element: unknown, test: Condition, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is Element & Predicate<Condition, Element>) &
|
||||
* (<Condition extends string>(element: unknown, test: Condition, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is Element & {tagName: Condition}) &
|
||||
* ((element?: null | undefined) => false) &
|
||||
* ((element: unknown, test?: null | undefined, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is Element) &
|
||||
* ((element: unknown, test?: Test, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => boolean)
|
||||
* )}
|
||||
*/
|
||||
(
|
||||
/**
|
||||
* @param {unknown} [element]
|
||||
* @param {Test | undefined} [test]
|
||||
* @param {number | null | undefined} [index]
|
||||
* @param {Parents | null | undefined} [parent]
|
||||
* @param {unknown} [context]
|
||||
* @returns {boolean}
|
||||
*/
|
||||
// eslint-disable-next-line max-params
|
||||
function (element, test, index, parent, context) {
|
||||
const check = convertElement(test)
|
||||
|
||||
if (
|
||||
index !== null &&
|
||||
index !== undefined &&
|
||||
(typeof index !== 'number' ||
|
||||
index < 0 ||
|
||||
index === Number.POSITIVE_INFINITY)
|
||||
) {
|
||||
throw new Error('Expected positive finite `index`')
|
||||
}
|
||||
|
||||
if (
|
||||
parent !== null &&
|
||||
parent !== undefined &&
|
||||
(!parent.type || !parent.children)
|
||||
) {
|
||||
throw new Error('Expected valid `parent`')
|
||||
}
|
||||
|
||||
if (
|
||||
(index === null || index === undefined) !==
|
||||
(parent === null || parent === undefined)
|
||||
) {
|
||||
throw new Error('Expected both `index` and `parent`')
|
||||
}
|
||||
|
||||
return looksLikeAnElement(element)
|
||||
? check.call(context, element, index, parent)
|
||||
: false
|
||||
}
|
||||
)
|
||||
|
||||
/**
|
||||
* Generate a check from a test.
|
||||
*
|
||||
* Useful if you’re going to test many nodes, for example when creating a
|
||||
* utility where something else passes a compatible test.
|
||||
*
|
||||
* The created function is a bit faster because it expects valid input only:
|
||||
* an `element`, `index`, and `parent`.
|
||||
*
|
||||
* @param test
|
||||
* A test for a specific element.
|
||||
* @returns
|
||||
* A check.
|
||||
*/
|
||||
export const convertElement =
|
||||
// Note: overloads in JSDoc can’t yet use different `@template`s.
|
||||
/**
|
||||
* @type {(
|
||||
* (<Condition extends TestFunction>(test: Condition) => (element: unknown, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is Element & Predicate<Condition, Element>) &
|
||||
* (<Condition extends string>(test: Condition) => (element: unknown, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is Element & {tagName: Condition}) &
|
||||
* ((test?: null | undefined) => (element?: unknown, index?: number | null | undefined, parent?: Parents | null | undefined, context?: unknown) => element is Element) &
|
||||
* ((test?: Test) => Check)
|
||||
* )}
|
||||
*/
|
||||
(
|
||||
/**
|
||||
* @param {Test | null | undefined} [test]
|
||||
* @returns {Check}
|
||||
*/
|
||||
function (test) {
|
||||
if (test === null || test === undefined) {
|
||||
return element
|
||||
}
|
||||
|
||||
if (typeof test === 'string') {
|
||||
return tagNameFactory(test)
|
||||
}
|
||||
|
||||
// Assume array.
|
||||
if (typeof test === 'object') {
|
||||
return anyFactory(test)
|
||||
}
|
||||
|
||||
if (typeof test === 'function') {
|
||||
return castFactory(test)
|
||||
}
|
||||
|
||||
throw new Error('Expected function, string, or array as `test`')
|
||||
}
|
||||
)
|
||||
|
||||
/**
|
||||
* Handle multiple tests.
|
||||
*
|
||||
* @param {Array<TestFunction | string>} tests
|
||||
* @returns {Check}
|
||||
*/
|
||||
function anyFactory(tests) {
|
||||
/** @type {Array<Check>} */
|
||||
const checks = []
|
||||
let index = -1
|
||||
|
||||
while (++index < tests.length) {
|
||||
checks[index] = convertElement(tests[index])
|
||||
}
|
||||
|
||||
return castFactory(any)
|
||||
|
||||
/**
|
||||
* @this {unknown}
|
||||
* @type {TestFunction}
|
||||
*/
|
||||
function any(...parameters) {
|
||||
let index = -1
|
||||
|
||||
while (++index < checks.length) {
|
||||
if (checks[index].apply(this, parameters)) return true
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Turn a string into a test for an element with a certain type.
|
||||
*
|
||||
* @param {string} check
|
||||
* @returns {Check}
|
||||
*/
|
||||
function tagNameFactory(check) {
|
||||
return castFactory(tagName)
|
||||
|
||||
/**
|
||||
* @param {Element} element
|
||||
* @returns {boolean}
|
||||
*/
|
||||
function tagName(element) {
|
||||
return element.tagName === check
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Turn a custom test into a test for an element that passes that test.
|
||||
*
|
||||
* @param {TestFunction} testFunction
|
||||
* @returns {Check}
|
||||
*/
|
||||
function castFactory(testFunction) {
|
||||
return check
|
||||
|
||||
/**
|
||||
* @this {unknown}
|
||||
* @type {Check}
|
||||
*/
|
||||
function check(value, index, parent) {
|
||||
return Boolean(
|
||||
looksLikeAnElement(value) &&
|
||||
testFunction.call(
|
||||
this,
|
||||
value,
|
||||
typeof index === 'number' ? index : undefined,
|
||||
parent || undefined
|
||||
)
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sure something is an element.
|
||||
*
|
||||
* @param {unknown} element
|
||||
* @returns {element is Element}
|
||||
*/
|
||||
function element(element) {
|
||||
return Boolean(
|
||||
element &&
|
||||
typeof element === 'object' &&
|
||||
'type' in element &&
|
||||
element.type === 'element' &&
|
||||
'tagName' in element &&
|
||||
typeof element.tagName === 'string'
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {unknown} value
|
||||
* @returns {value is Element}
|
||||
*/
|
||||
function looksLikeAnElement(value) {
|
||||
return (
|
||||
value !== null &&
|
||||
typeof value === 'object' &&
|
||||
'type' in value &&
|
||||
'tagName' in value
|
||||
)
|
||||
}
|
22
node_modules/hast-util-is-element/license
generated
vendored
Normal file
22
node_modules/hast-util-is-element/license
generated
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2016 Titus Wormer <tituswormer@gmail.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
'Software'), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
82
node_modules/hast-util-is-element/package.json
generated
vendored
Normal file
82
node_modules/hast-util-is-element/package.json
generated
vendored
Normal file
@@ -0,0 +1,82 @@
|
||||
{
|
||||
"name": "hast-util-is-element",
|
||||
"version": "3.0.0",
|
||||
"description": "hast utility to check if a node is a (certain) element",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"unist",
|
||||
"hast",
|
||||
"hast-util",
|
||||
"util",
|
||||
"utility",
|
||||
"html",
|
||||
"is",
|
||||
"element"
|
||||
],
|
||||
"repository": "syntax-tree/hast-util-is-element",
|
||||
"bugs": "https://github.com/syntax-tree/hast-util-is-element/issues",
|
||||
"funding": {
|
||||
"type": "opencollective",
|
||||
"url": "https://opencollective.com/unified"
|
||||
},
|
||||
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
|
||||
"contributors": [
|
||||
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
|
||||
],
|
||||
"sideEffects": false,
|
||||
"type": "module",
|
||||
"exports": "./index.js",
|
||||
"files": [
|
||||
"lib/",
|
||||
"index.d.ts",
|
||||
"index.js"
|
||||
],
|
||||
"dependencies": {
|
||||
"@types/hast": "^3.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^20.0.0",
|
||||
"c8": "^8.0.0",
|
||||
"prettier": "^3.0.0",
|
||||
"remark-cli": "^11.0.0",
|
||||
"remark-preset-wooorm": "^9.0.0",
|
||||
"tsd": "^0.28.0",
|
||||
"type-coverage": "^2.0.0",
|
||||
"typescript": "^5.0.0",
|
||||
"xo": "^0.55.0"
|
||||
},
|
||||
"scripts": {
|
||||
"prepack": "npm run build && npm run format",
|
||||
"build": "tsc --build --clean && tsc --build && tsd && type-coverage",
|
||||
"format": "remark . -qfo && prettier . -w --log-level warn && xo --fix",
|
||||
"test-api": "node --conditions development test.js",
|
||||
"test-coverage": "c8 --100 --reporter lcov npm run test-api",
|
||||
"test": "npm run build && npm run format && npm run test-coverage"
|
||||
},
|
||||
"prettier": {
|
||||
"bracketSpacing": false,
|
||||
"semi": false,
|
||||
"singleQuote": true,
|
||||
"tabWidth": 2,
|
||||
"trailingComma": "none",
|
||||
"useTabs": false
|
||||
},
|
||||
"remarkConfig": {
|
||||
"plugins": [
|
||||
"remark-preset-wooorm"
|
||||
]
|
||||
},
|
||||
"typeCoverage": {
|
||||
"atLeast": 100,
|
||||
"detail": true,
|
||||
"ignoreCatch": true,
|
||||
"#": "needed `any`s :'(",
|
||||
"ignoreFiles": [
|
||||
"lib/index.d.ts"
|
||||
],
|
||||
"strict": true
|
||||
},
|
||||
"xo": {
|
||||
"prettier": true
|
||||
}
|
||||
}
|
327
node_modules/hast-util-is-element/readme.md
generated
vendored
Normal file
327
node_modules/hast-util-is-element/readme.md
generated
vendored
Normal file
@@ -0,0 +1,327 @@
|
||||
# hast-util-is-element
|
||||
|
||||
[![Build][build-badge]][build]
|
||||
[![Coverage][coverage-badge]][coverage]
|
||||
[![Downloads][downloads-badge]][downloads]
|
||||
[![Size][size-badge]][size]
|
||||
[![Sponsors][sponsors-badge]][collective]
|
||||
[![Backers][backers-badge]][collective]
|
||||
[![Chat][chat-badge]][chat]
|
||||
|
||||
[hast][] utility to check if a node is a (certain) element.
|
||||
|
||||
## Contents
|
||||
|
||||
* [What is this?](#what-is-this)
|
||||
* [When should I use this?](#when-should-i-use-this)
|
||||
* [Install](#install)
|
||||
* [Use](#use)
|
||||
* [API](#api)
|
||||
* [`isElement(element[, test[, index, parent[, context]]])`](#iselementelement-test-index-parent-context)
|
||||
* [`convertElement(test)`](#convertelementtest)
|
||||
* [`Check`](#check)
|
||||
* [`Test`](#test)
|
||||
* [`TestFunction`](#testfunction)
|
||||
* [Types](#types)
|
||||
* [Compatibility](#compatibility)
|
||||
* [Security](#security)
|
||||
* [Related](#related)
|
||||
* [Contribute](#contribute)
|
||||
* [License](#license)
|
||||
|
||||
## What is this?
|
||||
|
||||
This package is a small utility that checks that a node is a certain element.
|
||||
|
||||
## When should I use this?
|
||||
|
||||
Use this small utility if you find yourself repeating code for checking what
|
||||
elements nodes are.
|
||||
|
||||
A similar package, [`unist-util-is`][unist-util-is], works on any unist node.
|
||||
|
||||
For more advanced tests, [`hast-util-select`][hast-util-select] can be used
|
||||
to match against CSS selectors.
|
||||
|
||||
## Install
|
||||
|
||||
This package is [ESM only][esm].
|
||||
In Node.js (version 16+), install with [npm][]:
|
||||
|
||||
```sh
|
||||
npm install hast-util-is-element
|
||||
```
|
||||
|
||||
In Deno with [`esm.sh`][esmsh]:
|
||||
|
||||
```js
|
||||
import {isElement} from 'https://esm.sh/hast-util-is-element@3'
|
||||
```
|
||||
|
||||
In browsers with [`esm.sh`][esmsh]:
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import {isElement} from 'https://esm.sh/hast-util-is-element@3?bundle'
|
||||
</script>
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
```js
|
||||
import {isElement} from 'hast-util-is-element'
|
||||
|
||||
isElement({type: 'text', value: 'foo'}) // => false
|
||||
isElement({type: 'element', tagName: 'a', properties: {}, children: []}) // => true
|
||||
isElement({type: 'element', tagName: 'a', properties: {}, children: []}, 'a') // => true
|
||||
isElement({type: 'element', tagName: 'a', properties: {}, children: []}, 'b') // => false
|
||||
isElement({type: 'element', tagName: 'a', properties: {}, children: []}, ['a', 'area']) // => true
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
This package exports the identifiers
|
||||
[`convertElement`][api-convert-element] and
|
||||
[`isElement`][api-is-element].
|
||||
There is no default export.
|
||||
|
||||
### `isElement(element[, test[, index, parent[, context]]])`
|
||||
|
||||
Check if `element` is an `Element` and whether it passes the given test.
|
||||
|
||||
###### Parameters
|
||||
|
||||
* `element` (`unknown`, optional)
|
||||
— thing to check, typically [`Node`][hast-node]
|
||||
* `test` ([`Test`][api-test], optional)
|
||||
— check for a specific element
|
||||
* `index` (`number`, optional)
|
||||
— position of `element` in its parent
|
||||
* `parent` ([`Parent`][hast-parent], optional)
|
||||
— parent of `element`
|
||||
* `context` (`unknown`, optional)
|
||||
— context object (`this`) to call `test` with
|
||||
|
||||
###### Returns
|
||||
|
||||
Whether `element` is an `Element` and passes a test (`boolean`).
|
||||
|
||||
###### Throws
|
||||
|
||||
When an incorrect `test`, `index`, or `parent` is given.
|
||||
There is no error thrown when `element` is not a node or not an element.
|
||||
|
||||
### `convertElement(test)`
|
||||
|
||||
Generate a check from a test.
|
||||
|
||||
Useful if you’re going to test many nodes, for example when creating a
|
||||
utility where something else passes a compatible test.
|
||||
|
||||
The created function is a bit faster because it expects valid input only:
|
||||
a `element`, `index`, and `parent`.
|
||||
|
||||
###### Parameters
|
||||
|
||||
* `test` ([`Test`][api-test], optional)
|
||||
— a test for a specific element
|
||||
|
||||
###### Returns
|
||||
|
||||
A check ([`Check`][api-check]).
|
||||
|
||||
### `Check`
|
||||
|
||||
Check that an arbitrary value is an element (TypeScript type).
|
||||
|
||||
###### Parameters
|
||||
|
||||
* `this` (`unknown`, optional)
|
||||
— context object (`this`) to call `test` with
|
||||
* `element` (`unknown`)
|
||||
— anything (typically an element)
|
||||
* `index` (`number`, optional)
|
||||
— position of `element` in its parent
|
||||
* `parent` ([`Parent`][hast-parent], optional)
|
||||
— parent of `element`
|
||||
|
||||
###### Returns
|
||||
|
||||
Whether this is an element and passes a test (`boolean`).
|
||||
|
||||
### `Test`
|
||||
|
||||
Check for an arbitrary element (TypeScript type).
|
||||
|
||||
* when `string`, checks that the element has that tag name
|
||||
* when `function`, see [`TestFunction`][api-test-function]
|
||||
* when `Array`, checks if one of the subtests pass
|
||||
|
||||
###### Type
|
||||
|
||||
```ts
|
||||
type Test =
|
||||
| Array<TestFunction | string>
|
||||
| TestFunction
|
||||
| string
|
||||
| null
|
||||
| undefined
|
||||
```
|
||||
|
||||
### `TestFunction`
|
||||
|
||||
Check if an element passes a test (TypeScript type).
|
||||
|
||||
###### Parameters
|
||||
|
||||
* `element` ([`Element`][hast-element])
|
||||
— an element
|
||||
* `index` (`number` or `undefined`)
|
||||
— position of `element` in its parent
|
||||
* `parent` ([`Parent`][hast-parent] or `undefined`)
|
||||
— parent of `element`
|
||||
|
||||
###### Returns
|
||||
|
||||
Whether this element passes the test (`boolean`, optional).
|
||||
|
||||
## Types
|
||||
|
||||
This package is fully typed with [TypeScript][].
|
||||
It exports the additional types [`Check`][api-check],
|
||||
[`Test`][api-test], and
|
||||
[`TestFunction`][api-test-function].
|
||||
|
||||
## Compatibility
|
||||
|
||||
Projects maintained by the unified collective are compatible with maintained
|
||||
versions of Node.js.
|
||||
|
||||
When we cut a new major release, we drop support for unmaintained versions of
|
||||
Node.
|
||||
This means we try to keep the current release line, `hast-util-is-element@^3`,
|
||||
compatible with Node.js 16.
|
||||
|
||||
## Security
|
||||
|
||||
`hast-util-is-element` does not change the syntax tree so there are no openings
|
||||
for [cross-site scripting (XSS)][xss] attacks.
|
||||
|
||||
## Related
|
||||
|
||||
* [`hast-util-has-property`](https://github.com/syntax-tree/hast-util-has-property)
|
||||
— check if a node has a property
|
||||
* [`hast-util-is-body-ok-link`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-is-body-ok-link)
|
||||
— check if a node is “Body OK” link element
|
||||
* [`hast-util-is-conditional-comment`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-is-conditional-comment)
|
||||
— check if a node is a conditional comment
|
||||
* [`hast-util-is-css-link`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-is-css-link)
|
||||
— check if a node is a CSS link element
|
||||
* [`hast-util-is-css-style`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-is-css-style)
|
||||
— check if a node is a CSS style element
|
||||
* [`hast-util-embedded`](https://github.com/syntax-tree/hast-util-embedded)
|
||||
— check if a node is an embedded element
|
||||
* [`hast-util-heading`](https://github.com/syntax-tree/hast-util-heading)
|
||||
— check if a node is a heading element
|
||||
* [`hast-util-interactive`](https://github.com/syntax-tree/hast-util-interactive)
|
||||
— check if a node is interactive
|
||||
* [`hast-util-is-javascript`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-is-javascript)
|
||||
— check if a node is a JavaScript script element
|
||||
* [`hast-util-labelable`](https://github.com/syntax-tree/hast-util-labelable)
|
||||
— check whether a node is labelable
|
||||
* [`hast-util-phrasing`](https://github.com/syntax-tree/hast-util-phrasing)
|
||||
— check if a node is phrasing content
|
||||
* [`hast-util-script-supporting`](https://github.com/syntax-tree/hast-util-script-supporting)
|
||||
— check if a node is a script-supporting element
|
||||
* [`hast-util-sectioning`](https://github.com/syntax-tree/hast-util-sectioning)
|
||||
— check if a node is a sectioning element
|
||||
* [`hast-util-transparent`](https://github.com/syntax-tree/hast-util-transparent)
|
||||
— check if a node is a transparent element
|
||||
* [`hast-util-whitespace`](https://github.com/syntax-tree/hast-util-whitespace)
|
||||
— check if a node is inter-element whitespace
|
||||
|
||||
## Contribute
|
||||
|
||||
See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
|
||||
ways to get started.
|
||||
See [`support.md`][support] for ways to get help.
|
||||
|
||||
This project has a [code of conduct][coc].
|
||||
By interacting with this repository, organization, or community you agree to
|
||||
abide by its terms.
|
||||
|
||||
## License
|
||||
|
||||
[MIT][license] © [Titus Wormer][author]
|
||||
|
||||
<!-- Definition -->
|
||||
|
||||
[build-badge]: https://github.com/syntax-tree/hast-util-is-element/workflows/main/badge.svg
|
||||
|
||||
[build]: https://github.com/syntax-tree/hast-util-is-element/actions
|
||||
|
||||
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-is-element.svg
|
||||
|
||||
[coverage]: https://codecov.io/github/syntax-tree/hast-util-is-element
|
||||
|
||||
[downloads-badge]: https://img.shields.io/npm/dm/hast-util-is-element.svg
|
||||
|
||||
[downloads]: https://www.npmjs.com/package/hast-util-is-element
|
||||
|
||||
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-is-element
|
||||
|
||||
[size]: https://bundlejs.com/?q=hast-util-is-element
|
||||
|
||||
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
|
||||
|
||||
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
|
||||
|
||||
[collective]: https://opencollective.com/unified
|
||||
|
||||
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
||||
|
||||
[chat]: https://github.com/syntax-tree/unist/discussions
|
||||
|
||||
[npm]: https://docs.npmjs.com/cli/install
|
||||
|
||||
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
|
||||
|
||||
[esmsh]: https://esm.sh
|
||||
|
||||
[typescript]: https://www.typescriptlang.org
|
||||
|
||||
[license]: license
|
||||
|
||||
[author]: https://wooorm.com
|
||||
|
||||
[health]: https://github.com/syntax-tree/.github
|
||||
|
||||
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
|
||||
|
||||
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
|
||||
|
||||
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
|
||||
|
||||
[hast]: https://github.com/syntax-tree/hast
|
||||
|
||||
[hast-node]: https://github.com/syntax-tree/hast#nodes
|
||||
|
||||
[hast-parent]: https://github.com/syntax-tree/hast#parent
|
||||
|
||||
[hast-element]: https://github.com/syntax-tree/hast#element
|
||||
|
||||
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
|
||||
|
||||
[unist-util-is]: https://github.com/syntax-tree/unist-util-is
|
||||
|
||||
[hast-util-select]: https://github.com/syntax-tree/hast-util-select
|
||||
|
||||
[api-is-element]: #iselementelement-test-index-parent-context
|
||||
|
||||
[api-convert-element]: #convertelementtest
|
||||
|
||||
[api-check]: #check
|
||||
|
||||
[api-test]: #test
|
||||
|
||||
[api-test-function]: #testfunction
|
Reference in New Issue
Block a user