Add helper functions documentation to engine docs

src/engine/docs/helpers/filter/comparison.md

@@ -0,0 +1,370 @@
+# string_not_equal
+
+## Signature
+
+```
+
+field: string_not_equal(any_string)
+```
+
+## Arguments
+
+| parameter | Type | Source | Accepted values |
+| --------- | ---- | ------ | --------------- |
+| any_string | string | value or reference | Any string |
+
+
+## Target Field
+
+| Type | Posible values |
+| ---- | -------------- |
+| string | Any string |
+
+
+## Description
+
+Checkers whether the two provided strings are equal, byte for byte.
+If they're not, the function evaluates to false. In case of error, the function will evaluate to false.
+This helper function is typically used in the check stage
+
+
+**Keywords**
+
+- `string` 
+
+- `comparison` 
+
+---
+# string_less
+
+## Signature
+
+```
+
+field: string_less(any_string)
+```
+
+## Arguments
+
+| parameter | Type | Source | Accepted values |
+| --------- | ---- | ------ | --------------- |
+| any_string | string | value or reference | Any string |
+
+
+## Target Field
+
+| Type | Posible values |
+| ---- | -------------- |
+| string | Any string |
+
+
+## Description
+
+Checkers whether the value stored in field is lexicographically less than to the one provided.
+If they're not, the function evaluates to false. In case of error, the function will evaluate to false.
+This helper function is typically used in the check stage
+
+
+**Keywords**
+
+- `string` 
+
+- `comparison` 
+
+---
+# string_less_or_equal
+
+## Signature
+
+```
+
+field: string_less_or_equal(any_string)
+```
+
+## Arguments
+
+| parameter | Type | Source | Accepted values |
+| --------- | ---- | ------ | --------------- |
+| any_string | string | value or reference | Any string |
+
+
+## Target Field
+
+| Type | Posible values |
+| ---- | -------------- |
+| string | Any string |
+
+
+## Description
+
+Checkers whether the value stored in field is lexicographically less than or equeal to the one provided.
+If they're not, the function evaluates to false. In case of error, the function will evaluate to false.
+This helper function is typically used in the check stage
+
+
+**Keywords**
+
+- `string` 
+
+- `comparison` 
+
+---
+# int_not_equal
+
+## Signature
+
+```
+
+field: int_not_equal(any_number)
+```
+
+## Arguments
+
+| parameter | Type | Source | Accepted values |
+| --------- | ---- | ------ | --------------- |
+| any_number | number | value or reference | Integers between `-2^63` and `2^63-1` |
+
+
+## Target Field
+
+| Type | Posible values |
+| ---- | -------------- |
+| number | Integers between `-2^63` and `2^63-1` |
+
+
+## Description
+
+Checkers whether the integer number stored in field is not equal to the one provided.
+If they're not, the function evaluates to false. In case of error, the function will evaluate to false.
+This helper function is typically used in the check stage
+
+
+**Keywords**
+
+- `integer` 
+
+- `comparison` 
+
+---
+# int_equal
+
+## Signature
+
+```
+
+field: int_equal(any_number)
+```
+
+## Arguments
+
+| parameter | Type | Source | Accepted values |
+| --------- | ---- | ------ | --------------- |
+| any_number | number | value or reference | Integers between `-2^63` and `2^63-1` |
+
+
+## Target Field
+
+| Type | Posible values |
+| ---- | -------------- |
+| number | Integers between `-2^63` and `2^63-1` |
+
+
+## Description
+
+Checkers whether the integer number stored in field is equal to the one provided.
+If they're not, the function evaluates to false. In case of error, the function will evaluate to false.
+This helper function is typically used in the check stage
+
+
+**Keywords**
+
+- `integer` 
+
+- `comparison` 
+
+---
+# int_less_or_equal
+
+## Signature
+
+```
+
+field: int_less_or_equal(any_number)
+```
+
+## Arguments
+
+| parameter | Type | Source | Accepted values |
+| --------- | ---- | ------ | --------------- |
+| any_number | number | value or reference | Integers between `-2^63` and `2^63-1` |
+
+
+## Target Field
+
+| Type | Posible values |
+| ---- | -------------- |
+| number | Integers between `-2^63` and `2^63-1` |
+
+
+## Description
+
+Checkers whether the integer number stored in field is less than or equal to the one provided.
+If they're not, the function evaluates to false. In case of error, the function will evaluate to false.
+This helper function is typically used in the check stage
+
+
+**Keywords**
+
+- `integer` 
+
+- `comparison` 
+
+---
+# int_greater
+
+## Signature
+
+```
+
+field: int_greater(any_number)
+```
+
+## Arguments
+
+| parameter | Type | Source | Accepted values |
+| --------- | ---- | ------ | --------------- |
+| any_number | number | value or reference | Integers between `-2^63` and `2^63-1` |
+
+
+## Target Field
+
+| Type | Posible values |
+| ---- | -------------- |
+| number | Integers between `-2^63` and `2^63-1` |
+
+
+## Description
+
+Checkers whether the integer number stored in field is greater than to the one provided.
+If they're not, the function evaluates to false. In case of error, the function will evaluate to false.
+This helper function is typically used in the check stage
+
+
+**Keywords**
+
+- `integer` 
+
+- `comparison` 
+
+---
+# string_equal
+
+## Signature
+
+```
+
+field: string_equal(any_string)
+```
+
+## Arguments
+
+| parameter | Type | Source | Accepted values |
+| --------- | ---- | ------ | --------------- |
+| any_string | string | value or reference | Any string |
+
+
+## Target Field
+
+| Type | Posible values |
+| ---- | -------------- |
+| string | Any string |
+
+
+## Description
+
+Checkers whether the value stored in field is equal to the one provided, byte for byte.
+If they're not, the function evaluates to false. In case of error, the function will evaluate to false.
+This helper function is typically used in the check stage
+
+
+**Keywords**
+
+- `string` 
+
+- `comparison` 
+
+---
+# int_less
+
+## Signature
+
+```
+
+field: int_less(any_number)
+```
+
+## Arguments
+
+| parameter | Type | Source | Accepted values |
+| --------- | ---- | ------ | --------------- |
+| any_number | number | value or reference | Integers between `-2^63` and `2^63-1` |
+
+
+## Target Field
+
+| Type | Posible values |
+| ---- | -------------- |
+| number | Integers between `-2^63` and `2^63-1` |
+
+
+## Description
+
+Checkers whether the integer number stored in field is less than to the one provided.
+If they're not, the function evaluates to false. In case of error, the function will evaluate to false.
+This helper function is typically used in the check stage
+
+
+**Keywords**
+
+- `integer` 
+
+- `comparison` 
+
+---
+# string_greater
+
+## Signature
+
+```
+
+field: string_greater(any_string)
+```
+
+## Arguments
+
+| parameter | Type | Source | Accepted values |
+| --------- | ---- | ------ | --------------- |
+| any_string | string | value or reference | Any string |
+
+
+## Target Field
+
+| Type | Posible values |
+| ---- | -------------- |
+| string | Any string |
+
+
+## Description
+
+Checks whether the value stored in field is lexicographically greater than to the one provided.
+If they're not, the function evaluates to false. In case of error, the function will evaluate to false.
+This helper function is typically used in the check stage
+
+
+**Keywords**
+
+- `string` 
+
+- `comparison` 
+
+---

src/engine/docs/helpers/filter/index.md

@@ -0,0 +1,7 @@
+# filter
+## Keywords
+- [comparison](./comparison.md)
+- [integer](./integer.md)
+- [kvdb](./kvdb.md)
+- [string](./string.md)
+- [undefined](./undefined.md)