From 3156bd0b94d4e9d42b0ec391c95c9b108bfbea72 Mon Sep 17 00:00:00 2001 From: Sunny Hirai Date: Sun, 6 Jun 2021 17:27:01 -0700 Subject: [PATCH] docs: Describe Text.matches in detail and describe 'loose' option in Text.equals --- docs/api/nodes/text.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/api/nodes/text.md b/docs/api/nodes/text.md index 3c65cc552..d78e91fee 100644 --- a/docs/api/nodes/text.md +++ b/docs/api/nodes/text.md @@ -18,7 +18,13 @@ interface Text { #### `Text.matches(text: Text, props: Partial) => boolean` -Check if a `text` matches a set of `props`. +Check if `text` matches a set of `props`. + +The way the check works is that it makes sure that (a) all the `props` exist in the `text`, and (b) if it exists, that it exactly matches the properties in the `text`. + +If a `props.text` property is passed in, it will be ignored. + +If there are properties in `text` that are not in `props`, those will be ignored when it comes to testing for a match. #### `Text.decorations(node: Text, decorations: Range[]) => Text[]` @@ -32,6 +38,8 @@ Check if two text nodes are equal. Options: `{loose?: boolean}` +- `loose?`: When `true`, it checks if the properties of the `Text` object are equal except for the `text` property (i.e. the `String` value of the `Text`). When `false` (default), checks all properties including `text`. + #### `Text.isText(value: any) => value is Text` Check if a `value` implements the `Text` interface.