From 58bf15e1656ed9d342571b399f7dc14699672f62 Mon Sep 17 00:00:00 2001 From: UnknownJoe796 Date: Tue, 19 Nov 2024 22:12:19 -0700 Subject: [PATCH] Update use-as-client.md Fixed some issues with the docs --- docs/use-as-client.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/use-as-client.md b/docs/use-as-client.md index 6ae8893b..2a500e22 100644 --- a/docs/use-as-client.md +++ b/docs/use-as-client.md @@ -61,7 +61,7 @@ Options: - Only let items through that fulfill every condition in the array. - `{ "Or": [] }` - Only let items through that fulfill at least one condition in the array. -- `{ "": }` +- `{ "": }` - Run a condition on a particular field. - `{ "Equal": }` - Only let through items that match the given value exactly. @@ -76,23 +76,23 @@ Options: - `{ "GreaterThanOrEqual": }` - `{ "LessThanOrEqual": }` - Comparison filters. Only operate on comparable values, like numbers and strings. -- `{ "StringContains": }` +- `{ "StringContains": { "value": , "ignoreCase": true } }` - Only let through values that contain the given string. Only operates on strings. -- `{ "RegexMatches": true }` +- `{ "RegexMatches": { "value": , "ignoreCase": true } }` - Only let through values that match the regular expression. Only operates on strings. -- `{ "ListAllElements": }` +- `{ "ListAllElements": }` - Only match lists where every element matches the given condition. -- `{ "ListAnyElements": }` +- `{ "ListAnyElements": }` - Only match lists where some element matches the given condition. - `{ "ListSizesEquals": }` - Only matches lists that contain exactly `count` elements. -- `{ "SetAllElements": }` +- `{ "SetAllElements": }` - Only match sets where every element matches the given condition. -- `{ "SetAnyElements": }` +- `{ "SetAnyElements": }` - Only match sets where some element matches the given condition. - `{ "SetSizesEquals": }` - Only matches sets that contain exactly `count` elements. -- `{ "IfNotNull": }` +- `{ "IfNotNull": }` - Allows you to run conditions on a nullable field Sample reads as "name is equal to Test and number is either 1, 2, or 3.": @@ -109,7 +109,15 @@ Sample reads as "name is equal to Test and number is either 1, 2, or 3.": "number": { "Inside": [1, 2, 3] } - } + }, + { + "listOfInts": { + "ListAnyElements": { + "Or": [{ "GreaterThan": 8 }, { "LessThan": 2 }] + } + } + }, + { "email": { "StringContains": { "value": "@domain.com", "ignoreCase": true } } } ] } ``` @@ -192,4 +200,4 @@ Sample reads as } ] } -``` \ No newline at end of file +```