Placeholder.path property

A utility placeholder the path on nested variables.

Signature:

path: string;

Remarks

When working with tables, you might want to retain the path to the property that failed.

Using a path, you can specify a place in your message for this data to be provided.

You can then "provide" a path via ExpectMessageBuilder.path().

Alternatively, you can use a Proxy to have this automatically provided.

Let's say we were checking if a value was an array:

new ExpectMessageBuilder(
  `${place.path} - Expected ${place.actual.value} to be an array`
);

We could then output messages like so:

parent.cars - Expected '2' to be an array