languages/duckscript
languages/duckscript
1
0
Fork 0
mirror of https://github.com/sagiegurari/duckscript synced 2024-10-14 11:53:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

sdk docs

Browse source
This commit is contained in:
sagie gur ari 2020-01-24 15:50:58 +00:00
parent b62418f8c3
commit 92434fbd87
2 changed files with 16 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
docs/sdk.md
View file

@ -2202,61 +2202,27 @@ clear_scope
## std::string::Concat
```sh
var = wget [--method=HTTP-method] [--post-data=payload] [-O file] URL
var = concat [value]*
```
Invokes a HTTP request.<br>
The request method by default is GET but can be modified by the ```--method``` parameter.<br>
The ```-O``` parameter will redirect a valid response output to the provided file, otherwise all response text will be set to the
output variable.<br>
When redirecting to file, the output would be the response size.<br>
The ```--post-data``` parameter enables to pass a payload to POST http requests.<br>
In case of errors or error HTTP response codes, false will be returned.
Concats the provided input into a single string and returns it.
#### Parameters
* Optional HTTP Method, for example --method=HTTP-GET or --method=HTTP-POST (currently only GET and POST are supported).
* Optional post payload via ```--post-data``` parameter.
* Optional redirection of output to file via ```-O``` parameter.
* The target URL
Any number of values to concat.
#### Return Value
The response text or in case of output redirection to file, the response size.<br>
In case of errors, it will return false.
The result of the concatenation of all input values.
#### Examples
```sh
function test_get
response = wget https://www.rust-lang.org/
output = concat 1 2 3 4
assert_eq ${output} 1234
found = contains ${response} Rust
assert ${found}
end
function test_get_to_file
file = set ./target/_duckscript_test/wget/page.html
rm ${file}
response_size = wget -O ${file} https://www.rust-lang.org/
response = readfile ${file}
found = contains ${response} Rust
assert ${found}
assert ${response_size}
end
function test_post
payload = set {\"login\":\"login\",\"password\":\"password\"}
response = wget --method=HTTP-POST --post-data=${payload} https://reqbin.com/echo/post/json
found = contains ${response} success
assert ${found}
end
output = concat 1 "2 3" 4
assert_eq ${output} "12 34"
```

50
duckscript_sdk/src/sdk/std/string/concat/help.md
View file

@ -1,57 +1,23 @@
```sh
var = wget [--method=HTTP-method] [--post-data=payload] [-O file] URL
var = concat [value]*
```
Invokes a HTTP request.<br>
The request method by default is GET but can be modified by the ```--method``` parameter.<br>
The ```-O``` parameter will redirect a valid response output to the provided file, otherwise all response text will be set to the
output variable.<br>
When redirecting to file, the output would be the response size.<br>
The ```--post-data``` parameter enables to pass a payload to POST http requests.<br>
In case of errors or error HTTP response codes, false will be returned.
Concats the provided input into a single string and returns it.
#### Parameters
* Optional HTTP Method, for example --method=HTTP-GET or --method=HTTP-POST (currently only GET and POST are supported).
* Optional post payload via ```--post-data``` parameter.
* Optional redirection of output to file via ```-O``` parameter.
* The target URL
Any number of values to concat.
#### Return Value
The response text or in case of output redirection to file, the response size.<br>
In case of errors, it will return false.
The result of the concatenation of all input values.
#### Examples
```sh
function test_get
response = wget https://www.rust-lang.org/
output = concat 1 2 3 4
assert_eq ${output} 1234
found = contains ${response} Rust
assert ${found}
end
function test_get_to_file
file = set ./target/_duckscript_test/wget/page.html
rm ${file}
response_size = wget -O ${file} https://www.rust-lang.org/
response = readfile ${file}
found = contains ${response} Rust
assert ${found}
assert ${response_size}
end
function test_post
payload = set {\"login\":\"login\",\"password\":\"password\"}
response = wget --method=HTTP-POST --post-data=${payload} https://reqbin.com/echo/post/json
found = contains ${response} success
assert ${found}
end
output = concat 1 "2 3" 4
assert_eq ${output} "12 34"
```