From eb808a3f8bbd97d2a2ea0114b43b708a17b44066 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 11 Apr 2025 14:34:51 +0200 Subject: Gun 2.2.0 --- docs/en/gun/2.2/manual/gun.options/index.html | 221 ++++++++++++++++++++++++++ 1 file changed, 221 insertions(+) create mode 100644 docs/en/gun/2.2/manual/gun.options/index.html (limited to 'docs/en/gun/2.2/manual/gun.options') diff --git a/docs/en/gun/2.2/manual/gun.options/index.html b/docs/en/gun/2.2/manual/gun.options/index.html new file mode 100644 index 00000000..47cd63c3 --- /dev/null +++ b/docs/en/gun/2.2/manual/gun.options/index.html @@ -0,0 +1,221 @@ + + + + + + + + + + Nine Nines: gun:options(3) + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

gun:options(3)

+ +

Name

+

gun:options - Query the capabilities of the server or a resource

+

Description

+
+
options(ConnPid, Path)
+    -> options(ConnPid, Path, [], #{}).
+
+options(ConnPid, Path, Headers)
+    -> options(ConnPid, Path, Headers, #{})
+
+options(ConnPid, Path, Headers, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: gun:req_headers()
+ReqOpts   :: gun:req_opts()
+StreamRef :: gun:stream_ref()
+
+

Query the capabilities of the server or a resource.

+

The special path "*" can be used to obtain information about the server as a whole. Any other path will return information about that resource specifically.

+

Arguments

+
ConnPid
+

The pid of the Gun connection process.

+
+
Path
+

Path to the resource.

+
+
Headers
+

Additional request headers.

+
+
ReqOpts
+

Request options.

+
+
+

Return value

+

A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.

+

Changelog

+
  • 1.0: Function introduced. +
    • +
+

Examples

+
Query the capabilities of the server
+
+
StreamRef = gun:options(ConnPid, "*").
+
+
Query the capabilities of a resource
+
+
StreamRef = gun:options(ConnPid, "/articles").
+
+

See also

+

gun(3), gun:await(3), gun:await_body(3), gun_inform(3), gun_response(3), gun_data(3)

+ + + + + + +
+ +
+ + +

+ Gun + 2.2 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via GitHub Sponsors. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.

+ + + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3