From 41c769ab5c19da92ecba35d9accc4bc123029e8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Tue, 23 May 2017 20:47:46 +0200 Subject: Remove the use of bootstrap-carousel The custom.js file was converted to not use jquery also. Once bootstrap is gone, we can remove jquery entirely. --- docs/en/gun/1.0/manual/gun/index.html | 164 ++++++++++++++++++++++++++++++---- 1 file changed, 147 insertions(+), 17 deletions(-) (limited to 'docs/en/gun/1.0/manual/gun/index.html') diff --git a/docs/en/gun/1.0/manual/gun/index.html b/docs/en/gun/1.0/manual/gun/index.html index 332b3b30..97314cd9 100644 --- a/docs/en/gun/1.0/manual/gun/index.html +++ b/docs/en/gun/1.0/manual/gun/index.html @@ -92,6 +92,14 @@ HTTP or Websocket.

The following keys are defined:

+connect_timeout ⇒ timeout() +
+
+

+ Connection timeout. Defaults to infinity. +

+
+
http_opts ⇒ http_opts()
@@ -193,6 +201,18 @@ keepalive ⇒ pos_integer()

+transform_header_name ⇒ funLowercaseName :: binary( → TransformedName :: binary()) | undefined +
+
+

+ A function that will be applied to all header names before they + are sent to the server. Gun assumes that all header names are in + lower case. This function is useful if you, for example, need to + re-case header names in the event that the server incorrectly + considers header name case to be significant. +

+
+
version ⇒ HTTP/1.1 | HTTP/1.0
@@ -203,6 +223,21 @@ version ⇒ HTTP/1.1 | HTTP/1.0
+

req_opts() = map()

+

Configuration for a particular request.

+

The following keys are defined:

+
+
+reply_to ⇒ pid() +
+
+

+ The pid of a process that is responsible for the response handling. +

+
+
+
+

spdy_opts() = map()

Configuration for the SPDY protocol.

The following keys are defined:

@@ -656,11 +691,15 @@ The pid of the Gun connection process. effectively closed.

-

delete(ConnPid, Path) → delete(ConnPid, Path, [])

-

Alias of gun:delete/3.

+

delete(ConnPid, Path) → delete(ConnPid, Path, [], #{})

+

Alias of gun:delete/4.

+
+
+

delete(ConnPid, Path, Headers) → delete(ConnPid, Path, Headers, #{})

+

Alias of gun:delete/4.

-

delete(ConnPid, Path, Headers) → StreamRef

+

delete(ConnPid, Path, Headers, ReqOpts) → StreamRef

ConnPid = pid() @@ -687,6 +726,14 @@ Additional request headers.

+ReqOpts = req_opts() +
+
+

+Request options. +

+
+
StreamRef = reference()
@@ -698,11 +745,15 @@ Identifier of the stream for this request.

Delete a resource.

-

get(ConnPid, Path) → get(ConnPid, Path, [])

-

Alias of gun:get/3.

+

get(ConnPid, Path) → get(ConnPid, Path, [], #{})

+

Alias of gun:get/4.

+
+
+

get(ConnPid, Path, Headers) → get(ConnPid, Path, Headers, #{})

+

Alias of gun:get/4.

-

get(ConnPid, Path, Headers) → StreamRef

+

get(ConnPid, Path, Headers, ReqOpts) → StreamRef

ConnPid = pid() @@ -729,6 +780,14 @@ Additional request headers.

+ReqOpts = req_opts() +
+
+

+Request options. +

+
+
StreamRef = reference()
@@ -740,11 +799,15 @@ Identifier of the stream for this request.

Get a resource.

-

head(ConnPid, Path) → head(ConnPid, Path, [])

-

Alias of gun:head/3.

+

head(ConnPid, Path) → head(ConnPid, Path, [], #{})

+

Alias of gun:head/4.

-

head(ConnPid, Path, Headers) → StreamRef

+

head(ConnPid, Path, Headers) → head(ConnPid, Path, Headers, #{})

+

Alias of gun:head/4.

+
+
+

head(ConnPid, Path, Headers, ReqOpts) → StreamRef

ConnPid = pid() @@ -771,6 +834,14 @@ Additional request headers.

+ReqOpts = req_opts() +
+
+

+Request options. +

+
+
StreamRef = reference()
@@ -788,11 +859,15 @@ request was a GET, like content-length, it is not always the case and differences may exist.

-

options(ConnPid, Path) → options(ConnPid, Path, [])

-

Alias of gun:options/3.

+

options(ConnPid, Path) → options(ConnPid, Path, [], #{})

+

Alias of gun:options/4.

-

options(ConnPid, Path, Headers) → StreamRef

+

options(ConnPid, Path, Headers) → options(ConnPid, Path, Headers, #{})

+

Alias of gun:options/4.

+
+
+

options(ConnPid, Path, Headers, ReqOpts) → StreamRef

ConnPid = pid() @@ -819,6 +894,14 @@ Additional request headers.

+ReqOpts = req_opts() +
+
+

+Request options. +

+
+
StreamRef = reference()
@@ -878,7 +961,11 @@ with instructions on how to update the resource.

You can use the gun:data/4 function to send the body, if any.

-

patch(ConnPid, Path, Headers, Body) → StreamRef

+

patch(ConnPid, Path, Headers, Body) → patch(ConnPid, Path, Headers, Body, #{})

+

Alias of gun:patch/5.

+
+
+

patch(ConnPid, Path, Headers, Body, ReqOpts) → StreamRef

ConnPid = pid() @@ -913,6 +1000,14 @@ Body of the request.

+ReqOpts = req_opts() +
+
+

+Request options. +

+
+
StreamRef = reference()
@@ -979,7 +1074,11 @@ located at a different URI.

You can use the gun:data/4 function to send the body, if any.

-

post(ConnPid, Path, Headers, Body) → StreamRef

+

post(ConnPid, Path, Headers, Body) → post(ConnPid, Path, Headers, Body, #{})

+

Alias of gun:post/5.

+
+
+

post(ConnPid, Path, Headers, Body, ReqOpts) → StreamRef

ConnPid = pid() @@ -1014,6 +1113,14 @@ Body of the request.

+ReqOpts = req_opts() +
+
+

+Request options. +

+
+
StreamRef = reference()
@@ -1079,7 +1186,11 @@ highly recommended to set both when possible.

You can use the gun:data/4 function to send the body, if any.

-

put(ConnPid, Path, Headers, Body) → StreamRef

+

put(ConnPid, Path, Headers, Body) → put(ConnPid, Path, Headers, Body, #{})

+

Alias of gun:put/5.

+
+
+

put(ConnPid, Path, Headers, Body, ReqOpts) → StreamRef

ConnPid = pid() @@ -1114,6 +1225,14 @@ Body of the request.

+ReqOpts = req_opts() +
+
+

+Request options. +

+
+
StreamRef = reference()
@@ -1185,7 +1304,11 @@ highly recommended to set both when possible.

You can use the gun:data/4 function to send the body, if any.

-

request(ConnPid, Method, Path, Headers, Body) → StreamRef

+

request(ConnPid, Method, Path, Headers, Body) → request(ConnPid, Method, Path, Headers, Body, #{})

+

Alias of gun:request/6.

+
+
+

request(ConnPid, Method, Path, Headers, Body, ReqOpts) → StreamRef

ConnPid = pid() @@ -1228,6 +1351,14 @@ Body of the request.

+ReqOpts = req_opts() +
+
+

+Request options. +

+
+
StreamRef = reference()
@@ -1727,7 +1858,6 @@ Frames = @todo - -- cgit v1.2.3