{"size": 1360, "ext": "scrbl", "max_stars_repo_path": "scribblings/parameters.scrbl", "max_stars_repo_name": "jessealama/riposte", "max_stars_repo_stars_event_min_datetime": "2018-11-08T19:12:04.000Z", "max_stars_repo_stars_event_max_datetime": "2021-06-11T16:09:15.000Z", "max_issues_repo_path": "scribblings/parameters.scrbl", "max_issues_repo_name": "jessealama/riposte", "max_issues_repo_issues_event_min_datetime": "2018-10-25T08:57:28.000Z", "max_issues_repo_issues_event_max_datetime": "2021-10-12T12:38:06.000Z", "max_forks_repo_path": "scribblings/parameters.scrbl", "max_forks_repo_name": "jessealama/riposte", "max_forks_repo_forks_event_min_datetime": "2018-11-15T08:33:59.000Z", "max_forks_repo_forks_event_max_datetime": "2021-02-05T21:07:15.000Z"}
{"max_stars_count": 37, "max_issues_count": 12, "max_forks_count": 5, "avg_line_length": 27.2, "max_line_length": 157, "alphanum_fraction": 0.7286764706}
#lang scribble/manual

@title{Parameters}

There are two parameters (AKA global variables) that steer the way the evaluation of Riposte works.

@itemlist[

@item{base URL}

@item{timeout}

]

@section{Base URI}

Sure, you can write out every URL you want, completely. Or you can save yourself some time, and make your scripts more readable to boot, by using a base URI.

Here's how you can set that:

@codeblock[#:keep-lang-line? #f #:line-numbers #f]|{
#lang riposte
%base := "https://whatever.test/v2/"
GET big/boy responds with 2XX
}|

When it comes time to build that @tt{GET} request, we'll use @tt{https://whatever.test/v2/big/boy} as the URI.

@section{Timeout}

Usually we want to wait only a ceratin amount of time before we give up on the server that we're working with. To control that, use @tt{%timeout}, like so:

@codeblock[#:keep-lang-line? #f #:line-numbers #f]|{
#lang riposte
%timeout := 5
GET /what/ever responds with 2XX
}|

The value should be a positive integer. (If it isn't, Riposte will die.) We will have

Riposte does not offer a way of disabling a timeout. Just use a big number if you want to give your requests a lot of time.

@codeblock[#:keep-lang-line? #f #:line-numbers #f]|{
#lang riposte
%timeout := 10000000000 # more than 300 years!
GET /what/ever responds with 2XX
}|

The default value for this parameter is 10 seconds.
