mirror of
https://github.com/nim-lang/Nim.git
synced 2026-01-09 14:32:53 +00:00
Implement RFC-391 (#18585)
This commit is contained in:
Juan Carlos
@@ -1,121 +1,120 @@
|
||||
## - Fetch for the JavaScript target: https://developer.mozilla.org/docs/Web/API/Fetch_API
|
||||
## .. Note:: jsfetch is Experimental. jsfetch module requires `-d:nimExperimentalJsfetch`
|
||||
## .. Note:: jsfetch is Experimental.
|
||||
when not defined(js):
|
||||
{.fatal: "Module jsfetch is designed to be used with the JavaScript backend.".}
|
||||
|
||||
when defined(nimExperimentalJsfetch):
|
||||
import std/[asyncjs, jsheaders, jsformdata]
|
||||
from std/httpcore import HttpMethod
|
||||
from std/jsffi import JsObject
|
||||
import std/[asyncjs, jsheaders, jsformdata]
|
||||
from std/httpcore import HttpMethod
|
||||
from std/jsffi import JsObject
|
||||
|
||||
type
|
||||
FetchOptions* = ref object of JsRoot ## Options for Fetch API.
|
||||
keepalive*: bool
|
||||
metod* {.importjs: "method".}: cstring
|
||||
body*, integrity*, referrer*, mode*, credentials*, cache*, redirect*, referrerPolicy*: cstring
|
||||
type
|
||||
FetchOptions* = ref object of JsRoot ## Options for Fetch API.
|
||||
keepalive*: bool
|
||||
metod* {.importjs: "method".}: cstring
|
||||
body*, integrity*, referrer*, mode*, credentials*, cache*, redirect*, referrerPolicy*: cstring
|
||||
|
||||
FetchModes* = enum ## Mode options.
|
||||
fmCors = "cors"
|
||||
fmNoCors = "no-cors"
|
||||
fmSameOrigin = "same-origin"
|
||||
FetchModes* = enum ## Mode options.
|
||||
fmCors = "cors"
|
||||
fmNoCors = "no-cors"
|
||||
fmSameOrigin = "same-origin"
|
||||
|
||||
FetchCredentials* = enum ## Credential options. See https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials
|
||||
fcInclude = "include"
|
||||
fcSameOrigin = "same-origin"
|
||||
fcOmit = "omit"
|
||||
FetchCredentials* = enum ## Credential options. See https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials
|
||||
fcInclude = "include"
|
||||
fcSameOrigin = "same-origin"
|
||||
fcOmit = "omit"
|
||||
|
||||
FetchCaches* = enum ## https://developer.mozilla.org/docs/Web/API/Request/cache
|
||||
fchDefault = "default"
|
||||
fchNoStore = "no-store"
|
||||
fchReload = "reload"
|
||||
fchNoCache = "no-cache"
|
||||
fchForceCache = "force-cache"
|
||||
FetchCaches* = enum ## https://developer.mozilla.org/docs/Web/API/Request/cache
|
||||
fchDefault = "default"
|
||||
fchNoStore = "no-store"
|
||||
fchReload = "reload"
|
||||
fchNoCache = "no-cache"
|
||||
fchForceCache = "force-cache"
|
||||
|
||||
FetchRedirects* = enum ## Redirects options.
|
||||
frFollow = "follow"
|
||||
frError = "error"
|
||||
frManual = "manual"
|
||||
FetchRedirects* = enum ## Redirects options.
|
||||
frFollow = "follow"
|
||||
frError = "error"
|
||||
frManual = "manual"
|
||||
|
||||
FetchReferrerPolicies* = enum ## Referrer Policy options.
|
||||
frpNoReferrer = "no-referrer"
|
||||
frpNoReferrerWhenDowngrade = "no-referrer-when-downgrade"
|
||||
frpOrigin = "origin"
|
||||
frpOriginWhenCrossOrigin = "origin-when-cross-origin"
|
||||
frpUnsafeUrl = "unsafe-url"
|
||||
FetchReferrerPolicies* = enum ## Referrer Policy options.
|
||||
frpNoReferrer = "no-referrer"
|
||||
frpNoReferrerWhenDowngrade = "no-referrer-when-downgrade"
|
||||
frpOrigin = "origin"
|
||||
frpOriginWhenCrossOrigin = "origin-when-cross-origin"
|
||||
frpUnsafeUrl = "unsafe-url"
|
||||
|
||||
Body* = ref object of JsRoot ## https://developer.mozilla.org/en-US/docs/Web/API/Body
|
||||
bodyUsed*: bool
|
||||
Body* = ref object of JsRoot ## https://developer.mozilla.org/en-US/docs/Web/API/Body
|
||||
bodyUsed*: bool
|
||||
|
||||
Response* = ref object of JsRoot ## https://developer.mozilla.org/en-US/docs/Web/API/Response
|
||||
bodyUsed*, ok*, redirected*: bool
|
||||
typ* {.importjs: "type".}: cstring
|
||||
url*, statusText*: cstring
|
||||
status*: cint
|
||||
headers*: Headers
|
||||
body*: Body
|
||||
Response* = ref object of JsRoot ## https://developer.mozilla.org/en-US/docs/Web/API/Response
|
||||
bodyUsed*, ok*, redirected*: bool
|
||||
typ* {.importjs: "type".}: cstring
|
||||
url*, statusText*: cstring
|
||||
status*: cint
|
||||
headers*: Headers
|
||||
body*: Body
|
||||
|
||||
Request* = ref object of JsRoot ## https://developer.mozilla.org/en-US/docs/Web/API/Request
|
||||
bodyUsed*, ok*, redirected*: bool
|
||||
typ* {.importjs: "type".}: cstring
|
||||
url*, statusText*: cstring
|
||||
status*: cint
|
||||
headers*: Headers
|
||||
body*: Body
|
||||
Request* = ref object of JsRoot ## https://developer.mozilla.org/en-US/docs/Web/API/Request
|
||||
bodyUsed*, ok*, redirected*: bool
|
||||
typ* {.importjs: "type".}: cstring
|
||||
url*, statusText*: cstring
|
||||
status*: cint
|
||||
headers*: Headers
|
||||
body*: Body
|
||||
|
||||
|
||||
func newResponse*(body: cstring | FormData): Response {.importjs: "(new Response(#))".}
|
||||
## Constructor for `Response`. This does *not* call `fetch()`. Same as `new Response()`.
|
||||
func newResponse*(body: cstring | FormData): Response {.importjs: "(new Response(#))".}
|
||||
## Constructor for `Response`. This does *not* call `fetch()`. Same as `new Response()`.
|
||||
|
||||
func newRequest*(url: cstring): Request {.importjs: "(new Request(#))".}
|
||||
## Constructor for `Request`. This does *not* call `fetch()`. Same as `new Request()`.
|
||||
func newRequest*(url: cstring): Request {.importjs: "(new Request(#))".}
|
||||
## Constructor for `Request`. This does *not* call `fetch()`. Same as `new Request()`.
|
||||
|
||||
func clone*(self: Response | Request): Response {.importjs: "#.$1()".}
|
||||
## https://developer.mozilla.org/en-US/docs/Web/API/Response/clone
|
||||
func clone*(self: Response | Request): Response {.importjs: "#.$1()".}
|
||||
## https://developer.mozilla.org/en-US/docs/Web/API/Response/clone
|
||||
|
||||
proc text*(self: Response): Future[cstring] {.importjs: "#.$1()".}
|
||||
## https://developer.mozilla.org/en-US/docs/Web/API/Body/text
|
||||
proc text*(self: Response): Future[cstring] {.importjs: "#.$1()".}
|
||||
## https://developer.mozilla.org/en-US/docs/Web/API/Body/text
|
||||
|
||||
proc json*(self: Response): Future[JsObject] {.importjs: "#.$1()".}
|
||||
## https://developer.mozilla.org/en-US/docs/Web/API/Body/json
|
||||
proc json*(self: Response): Future[JsObject] {.importjs: "#.$1()".}
|
||||
## https://developer.mozilla.org/en-US/docs/Web/API/Body/json
|
||||
|
||||
proc formData*(self: Body): Future[FormData] {.importjs: "#.$1()".}
|
||||
## https://developer.mozilla.org/en-US/docs/Web/API/Body/formData
|
||||
proc formData*(self: Body): Future[FormData] {.importjs: "#.$1()".}
|
||||
## https://developer.mozilla.org/en-US/docs/Web/API/Body/formData
|
||||
|
||||
proc unsafeNewFetchOptions*(metod, body, mode, credentials, cache, referrerPolicy: cstring;
|
||||
keepalive: bool; redirect = "follow".cstring; referrer = "client".cstring; integrity = "".cstring): FetchOptions {.importjs:
|
||||
"{method: #, body: #, mode: #, credentials: #, cache: #, referrerPolicy: #, keepalive: #, redirect: #, referrer: #, integrity: #}".}
|
||||
## .. warning:: Unsafe `newfetchOptions`.
|
||||
proc unsafeNewFetchOptions*(metod, body, mode, credentials, cache, referrerPolicy: cstring;
|
||||
keepalive: bool; redirect = "follow".cstring; referrer = "client".cstring; integrity = "".cstring): FetchOptions {.importjs:
|
||||
"{method: #, body: #, mode: #, credentials: #, cache: #, referrerPolicy: #, keepalive: #, redirect: #, referrer: #, integrity: #}".}
|
||||
## .. warning:: Unsafe `newfetchOptions`.
|
||||
|
||||
func newfetchOptions*(metod: HttpMethod; body: cstring;
|
||||
mode: FetchModes; credentials: FetchCredentials; cache: FetchCaches; referrerPolicy: FetchReferrerPolicies;
|
||||
keepalive: bool; redirect = frFollow; referrer = "client".cstring; integrity = "".cstring): FetchOptions =
|
||||
## Constructor for `FetchOptions`.
|
||||
result = FetchOptions(
|
||||
body: body, mode: $mode, credentials: $credentials, cache: $cache, referrerPolicy: $referrerPolicy,
|
||||
keepalive: keepalive, redirect: $redirect, referrer: referrer, integrity: integrity,
|
||||
metod: (case metod
|
||||
of HttpHead: "HEAD".cstring
|
||||
of HttpGet: "GET".cstring
|
||||
of HttpPost: "POST".cstring
|
||||
of HttpPut: "PUT".cstring
|
||||
of HttpDelete: "DELETE".cstring
|
||||
of HttpPatch: "PATCH".cstring
|
||||
else: "GET".cstring
|
||||
)
|
||||
func newfetchOptions*(metod: HttpMethod; body: cstring;
|
||||
mode: FetchModes; credentials: FetchCredentials; cache: FetchCaches; referrerPolicy: FetchReferrerPolicies;
|
||||
keepalive: bool; redirect = frFollow; referrer = "client".cstring; integrity = "".cstring): FetchOptions =
|
||||
## Constructor for `FetchOptions`.
|
||||
result = FetchOptions(
|
||||
body: body, mode: $mode, credentials: $credentials, cache: $cache, referrerPolicy: $referrerPolicy,
|
||||
keepalive: keepalive, redirect: $redirect, referrer: referrer, integrity: integrity,
|
||||
metod: (case metod
|
||||
of HttpHead: "HEAD".cstring
|
||||
of HttpGet: "GET".cstring
|
||||
of HttpPost: "POST".cstring
|
||||
of HttpPut: "PUT".cstring
|
||||
of HttpDelete: "DELETE".cstring
|
||||
of HttpPatch: "PATCH".cstring
|
||||
else: "GET".cstring
|
||||
)
|
||||
)
|
||||
|
||||
proc fetch*(url: cstring | Request): Future[Response] {.importjs: "$1(#)".}
|
||||
## `fetch()` API, simple `GET` only, returns a `Future[Response]`.
|
||||
proc fetch*(url: cstring | Request): Future[Response] {.importjs: "$1(#)".}
|
||||
## `fetch()` API, simple `GET` only, returns a `Future[Response]`.
|
||||
|
||||
proc fetch*(url: cstring | Request; options: FetchOptions): Future[Response] {.importjs: "$1(#, #)".}
|
||||
## `fetch()` API that takes a `FetchOptions`, returns a `Future[Response]`.
|
||||
proc fetch*(url: cstring | Request; options: FetchOptions): Future[Response] {.importjs: "$1(#, #)".}
|
||||
## `fetch()` API that takes a `FetchOptions`, returns a `Future[Response]`.
|
||||
|
||||
func toCstring*(self: Request | Response | Body | FetchOptions): cstring {.importjs: "JSON.stringify(#)".}
|
||||
func toCstring*(self: Request | Response | Body | FetchOptions): cstring {.importjs: "JSON.stringify(#)".}
|
||||
|
||||
func `$`*(self: Request | Response | Body | FetchOptions): string = $toCstring(self)
|
||||
func `$`*(self: Request | Response | Body | FetchOptions): string = $toCstring(self)
|
||||
|
||||
|
||||
runnableExamples("-d:nimExperimentalJsfetch -r:off"):
|
||||
runnableExamples("-r:off"):
|
||||
import std/[asyncjs, jsconsole, jsheaders, jsformdata]
|
||||
from std/httpcore import HttpMethod
|
||||
from std/jsffi import JsObject
|
||||
|
||||
@@ -33,7 +33,6 @@ hint("Processing", off)
|
||||
# experimental API's are enabled in testament, refs https://github.com/timotheecour/Nim/issues/575
|
||||
# sync with `kochdocs.docDefines` or refactor.
|
||||
switch("define", "nimExperimentalAsyncjsThen")
|
||||
switch("define", "nimExperimentalJsfetch")
|
||||
switch("define", "nimExperimentalLinenoiseExtra")
|
||||
|
||||
switch("define", "nimPreviewFloatRoundtrip")
|
||||
|
||||
@@ -8,7 +8,7 @@ const
|
||||
gaCode* = " --doc.googleAnalytics:UA-48159761-1"
|
||||
# errormax: subsequent errors are probably consequences of 1st one; a simple
|
||||
# bug could cause unlimited number of errors otherwise, hard to debug in CI.
|
||||
docDefines = "-d:nimExperimentalAsyncjsThen -d:nimExperimentalJsfetch -d:nimExperimentalLinenoiseExtra"
|
||||
docDefines = "-d:nimExperimentalAsyncjsThen -d:nimExperimentalLinenoiseExtra"
|
||||
nimArgs = "--errormax:3 --hint:Conf:off --hint:Path:off --hint:Processing:off --hint:XDeclaredButNotUsed:off --warning:UnusedImport:off -d:boot --putenv:nimversion=$# $#" % [system.NimVersion, docDefines]
|
||||
gitUrl = "https://github.com/nim-lang/Nim"
|
||||
docHtmlOutput = "doc/html"
|
||||
|
||||
Reference in New Issue
Block a user