Skip to content

feat: add isElement method #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ardalanamini merged 1 commit into from
Sep 4, 2022
Merged

feat: add isElement method #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions __tests__/is-element.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { isElement } from "@extremejs/utils";

it("should check if value is likely a DOM element", () => {
class Element {

public readonly nodeType = 1;

}

expect(isElement(new Element)).toBe(true);

expect(isElement("<body>")).toBe(false);
});
1 change: 1 addition & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export { default as isArrayLikeObject } from "./is-array-like-object.js";
export { default as isBoolean } from "./is-boolean.js";
export { default as isBuffer } from "./is-buffer.js";
export { default as isDate } from "./is-date.js";
export { default as isElement } from "./is-element.js";
export { default as isError } from "./is-error.js";
export { default as isEven } from "./is-even.js";
export { default as isFinite } from "./is-finite.js";
Expand Down
18 changes: 18 additions & 0 deletions src/is-element.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import isObjectLike from "./is-object-like.js";
import isPlainObject from "./is-plain-object.js";

/**
* Checks if `value` is likely a `DOM` element.
* @group Other
* @since 1.0.0
* @param value
* @example
* isElement(document.body);
* // => true
* @example
* isElement("<body>");
* // => false
*/
export default function isElement(value: unknown): value is Element {
return isObjectLike(value) && value.nodeType === 1 && !isPlainObject(value);
}