Skip to content

chore: update expression readme #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 11, 2022
Merged

chore: update expression readme #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/push_main.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ jobs:
verbose: true
release_check:
runs-on: ubuntu-latest
needs: [test, lint]
outputs:
git_diff: ${{ steps.output.outputs.git_diff }}
steps:
Expand All @@ -94,7 +93,7 @@ jobs:
echo "::set-output name=git_diff::${{ env.GIT_DIFF }}"
release:
runs-on: ubuntu-latest
needs: [release_check]
needs: [test, lint, release_check]
if: ${{ needs.release_check.outputs.git_diff }}
outputs:
version: ${{ steps.release.outputs.version }}
Expand Down
6 changes: 6 additions & 0 deletions script/standard/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ The standard script engine is a basic implementation of the script.Engine interf
|`*`|multiplication|number|return the left-side number multiplied by the right-side number|
|`/`|division|number|return the left-side number divided by the right-side number|
|`%`|modulus|integer|return the remainder of the left-side number divided by the right-side number|
|`in`|in|number\|string\|boolean and collection|return true if the left-side argument is in the right-side collection|
|`not in`|in|number\|string\|boolean and collection|return true if the left-side argument is not in the right-side collection|

All operators have a left-side and right-side argument, expect the not `!` operator which only as a right-side argument. The arguments can be strings, numbers, boolean values, arrays, objects, a special parameter, or other expressions, for example `true && true || false` includes the logical AND operator with left-side `true` and right-side a logical OR operator with left-side `true` and right-side `false`.

Expand All @@ -33,6 +35,10 @@ The right side pattern should be passed as a string, between single or double qu

> the regex operation is handled by the standard [`regexp`](https://pkg.go.dev/regexp) golang library `Match` function.

### In and Not In

The `in` and `not in` operators will check if the left-side value, treated either as a number, string, or boolean value, is included in the right-side collection values, a collection can either be an array, slice, or the values of a map.

## Special Parameters

The following symbols/tokens have special meaning when used in script expressions and will be replaced before the expression is evaluated. The symbols used within a string, between single or double quotes, will not be replaced.
Expand Down