Interface: Reference

Extends

• Exclude<ReferenceOptions, "prefix">

Properties

Property	Type	Description	Inherited from
adjust?	(value: any) => any	a function with the signature function(value) where value is the resolved reference value and the return value is the adjusted value to use. Note that the adjust feature will not perform any type validation on the adjusted value and it must match the value expected by the rule it is used in. Cannot be used with map. Example (value) => value + 5	Exclude.adjust
ancestor?	number	If set to a number, sets the reference relative starting point. Cannot be combined with separator prefix characters. Defaults to the reference key prefix (or 1 if none present)	Exclude.ancestor
depth	number	-	-
display	string	-	-
in?	boolean	creates an in-reference.	Exclude.in
iterables?	boolean	when true, the reference resolves by reaching into maps and sets.	Exclude.iterables
key	string	-	-
map?	[any, any][]	an array of array pairs using the format [[key, value], [key, value]] used to maps the resolved reference value to another value. If the resolved value is not in the map, it is returned as-is. Cannot be used with adjust.	Exclude.map
path	string[]	-	-
prefix?	{ global?: string; local?: string; root?: string; }	overrides default prefix characters.	Exclude.prefix
prefix.global?	string	references to the globally provided context preference. Default '$'	-
prefix.local?	string	references to error-specific or rule specific context. Default '#'	-
prefix.root?	string	references to the root value being validated. Default '/'	-
render?	boolean	when true, the value of the reference is used instead of its name in error messages and template rendering. Defaults to false.	Exclude.render
root	string	-	-
separator?	string | false	overrides the default . hierarchy separator. Set to false to treat the key as a literal value. Default '.'	Exclude.separator
type	string	-	-

Methods

toString()

toString(): string;

Returns a string representation of an object.

Returns

string