Skip to content

Commit

Permalink
docs: Fix typos in JSDoc and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
izure1 committed Mar 24, 2024
1 parent e1ce80a commit aa44b12
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ class AgeComparator extends ValueComparator<MyObject> {
}

match(value: MyObject): string {
return value.age
return value.age.toString()
}
}
```
Expand All @@ -141,7 +141,7 @@ The **asc** method should return values in ascending order. If the return value

#### match

The `match` method is used for the **LIKE** operator. This method specifies which value to test against a regular expression. For example, if you have a tree with values of the structure `{ country: string, capital: number }`, and you want to perform a **LIKE** operation based on the **capital** value, the method should return **value.capital**. In this case, you **CANNOT** perform a **LIKE** operation based on the **country** attribute. The returned value must be a string.
The `match` method is used for the **LIKE** operator. This method specifies which value to test against a regular expression. For example, if you have a tree with values of the structure `{ country: string, capital: string }`, and you want to perform a **LIKE** operation based on the **capital** value, the method should return **value.capital**. In this case, you **CANNOT** perform a **LIKE** operation based on the **country** attribute. The returned value must be a string.

```typescript
interface MyObject {
Expand Down
2 changes: 1 addition & 1 deletion src/base/ValueComparator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export abstract class ValueComparator<V> {
* The `match` method is used for the **LIKE** operator.
* This method specifies which value to test against a regular expression.
*
* For example, if you have a tree with values of the structure `{ country: string, capital: number }`,
* For example, if you have a tree with values of the structure `{ country: string, capital: string }`,
* and you want to perform a **LIKE** operation based on the **capital** value, the method should return **value.capital**.
* In this case, you **CANNOT** perform a **LIKE** operation based on the **country** attribute.
* The returned value must be a string.
Expand Down

0 comments on commit aa44b12

Please sign in to comment.