RegExpValue

Official

Both Official Unofficial

Both Own Inherited

Value wrapping a RegExp pattern.

Import:

import { RegExpValue } from 'obsidian';

Signature:

export class RegExpValue extends NotNullValue

Extends: NotNullValue

Constructor

new RegExpValue(regexp: RegExp)

Constructor.

To get the constructor instance, use getRegExpValueConstructor from obsidian-typings/implementations.

Properties

	Property	Type	Description
	icon	string	The lucide icon name representing this value's type. (Inherited from NotNullValue)
	regexp	RegExp	The wrapped regular expression.
	type	string	(Inherited from NotNullValue)

Methods

	Method	Returns	Description
	equals(a, b)	boolean	(Inherited from NotNullValue)
	equals(other)	boolean	Returns a boolean indicating whether this Value is equal to the provided Value. (Inherited from NotNullValue)
	isTruthy()	boolean	Returns a boolean indicating whether this obsidian#RegExpValue is truthy.
	keys()	string[]	Returns the property keys accessible on this value via Value.objectAccess. (Inherited from NotNullValue)
	looseEquals(a, b)	boolean	(Inherited from NotNullValue)
	looseEquals(other)	boolean	Returns a boolean indicating whether this Value is loosely equal to the provided Value. (Inherited from NotNullValue)
	objectAccess(key)	null | Value	Accesses a named sub-property of this value. (Inherited from NotNullValue)
	renderTo(el, ctx)	void	Render this value into the provided HTMLElement. (Inherited from NotNullValue)
	toString()	string	Get the string representation of this obsidian#RegExpValue.

---

Links to this page:

• getRegExpValueConstructor