Index

Modules: yahttp, yahttp/exceptions, yahttp/internal/utils.

API symbols

BasicAuth:

• yahttp: tuple BasicAuth

DELETE:

• yahttp: Method.DELETE

delete:

• yahttp: proc delete(url`gensym24: string; headers`gensym24: openArray[RequestHeader] = []; query`gensym24: openArray[QueryParam] = []; encodeQueryParams`gensym24: EncodeQueryParams = defaultEncodeQueryParams; body`gensym24: string = ""; files`gensym24: openArray[MultipartFile] = []; streamingFiles`gensym24: openArray[StreamingMultipartFile] = []; auth`gensym24: BasicAuth = ("", ""); timeout`gensym24 = -1; ignoreSsl`gensym24 = false; sslContext`gensym24: SslContext = nil): Response

EncodeQueryParams:

• yahttp: object EncodeQueryParams

GET:

• yahttp: Method.GET

get:

• yahttp: proc get(url`gensym18: string; headers`gensym18: openArray[RequestHeader] = []; query`gensym18: openArray[QueryParam] = []; encodeQueryParams`gensym18: EncodeQueryParams = defaultEncodeQueryParams; auth`gensym18: BasicAuth = ("", ""); timeout`gensym18 = -1; ignoreSsl`gensym18 = false; sslContext`gensym18: SslContext = nil): Response

HEAD:

• yahttp: Method.HEAD

head:

• yahttp: proc head(url`gensym19: string; headers`gensym19: openArray[RequestHeader] = []; query`gensym19: openArray[QueryParam] = []; encodeQueryParams`gensym19: EncodeQueryParams = defaultEncodeQueryParams; auth`gensym19: BasicAuth = ("", ""); timeout`gensym19 = -1; ignoreSsl`gensym19 = false; sslContext`gensym19: SslContext = nil): Response

html:

• yahttp: proc html(response: Response): XmlNode

HttpError:

• exceptions: object HttpError

http_method_gen:

• utils: macro http_method_gen(name: untyped): untyped

http_method_no_body_gen:

• utils: macro http_method_no_body_gen(name: untyped): untyped

json:

• yahttp: proc json(response: Response): JsonNode

Method:

• yahttp: enum Method

MultipartFile:

• yahttp: tuple MultipartFile

ok:

• yahttp: proc ok(response: Response): bool

OPTIONS:

• yahttp: Method.OPTIONS

options:

• yahttp: proc options(url`gensym20: string; headers`gensym20: openArray[RequestHeader] = []; query`gensym20: openArray[QueryParam] = []; encodeQueryParams`gensym20: EncodeQueryParams = defaultEncodeQueryParams; auth`gensym20: BasicAuth = ("", ""); timeout`gensym20 = -1; ignoreSsl`gensym20 = false; sslContext`gensym20: SslContext = nil): Response

PATCH:

• yahttp: Method.PATCH

patch:

• yahttp: proc patch(url`gensym23: string; headers`gensym23: openArray[RequestHeader] = []; query`gensym23: openArray[QueryParam] = []; encodeQueryParams`gensym23: EncodeQueryParams = defaultEncodeQueryParams; body`gensym23: string = ""; files`gensym23: openArray[MultipartFile] = []; streamingFiles`gensym23: openArray[StreamingMultipartFile] = []; auth`gensym23: BasicAuth = ("", ""); timeout`gensym23 = -1; ignoreSsl`gensym23 = false; sslContext`gensym23: SslContext = nil): Response

POST:

• yahttp: Method.POST

post:

• yahttp: proc post(url`gensym22: string; headers`gensym22: openArray[RequestHeader] = []; query`gensym22: openArray[QueryParam] = []; encodeQueryParams`gensym22: EncodeQueryParams = defaultEncodeQueryParams; body`gensym22: string = ""; files`gensym22: openArray[MultipartFile] = []; streamingFiles`gensym22: openArray[StreamingMultipartFile] = []; auth`gensym22: BasicAuth = ("", ""); timeout`gensym22 = -1; ignoreSsl`gensym22 = false; sslContext`gensym22: SslContext = nil): Response

PUT:

• yahttp: Method.PUT

put:

• yahttp: proc put(url`gensym21: string; headers`gensym21: openArray[RequestHeader] = []; query`gensym21: openArray[QueryParam] = []; encodeQueryParams`gensym21: EncodeQueryParams = defaultEncodeQueryParams; body`gensym21: string = ""; files`gensym21: openArray[MultipartFile] = []; streamingFiles`gensym21: openArray[StreamingMultipartFile] = []; auth`gensym21: BasicAuth = ("", ""); timeout`gensym21 = -1; ignoreSsl`gensym21 = false; sslContext`gensym21: SslContext = nil): Response

QueryParam:

• yahttp: tuple QueryParam

raiseForStatus:

• yahttp: proc raiseForStatus(response: Response)

Request:

• yahttp: object Request

request:

• yahttp: proc request(url: string; httpMethod: Method = Method.GET; headers: openArray[RequestHeader] = []; query: openArray[QueryParam] = []; encodeQueryParams: EncodeQueryParams = defaultEncodeQueryParams; body: string = ""; files: openArray[MultipartFile] = []; streamingFiles: openArray[StreamingMultipartFile] = []; auth: BasicAuth = ("", ""); timeout = -1; ignoreSsl = false; sslContext: SslContext = nil): Response

RequestHeader:

• yahttp: tuple RequestHeader

Response:

• yahttp: object Response

StreamingMultipartFile:

• yahttp: tuple StreamingMultipartFile

to:

• yahttp: proc to[T](response: Response; t: typedesc[T]): T

toJsonString:

• yahttp: proc toJsonString(obj: object): string