reacl-c-basics.ajax

Liking cljdoc? Tell your friends :D

ClojureScript only.

check-options-invariants!^cljs

(check-options-invariants! options)

source

DELETE^cljs

(DELETE uri & [options])

source

deliver^cljs

(deliver req & [info])

Returns an action to add the given request to the end of the next queue [[delivery-queue]] up in the item tree. An arbitrary info value can be attached, identifying or describing the request.

Returns an action to add the given request to the end of the next
queue [[delivery-queue]] up in the item tree. An arbitrary `info`
value can be attached, identifying or describing the request.

source raw docstring

delivery^cljs

(delivery item)

(delivery item options)

(delivery item transition manage)

Returns an item that manages execution of Ajax requests in its local state. Use deliver to get an action that can be emitted by item that adds a new delivery job to an internal queue.

Jobs transition from a :pending state, over :running into :completed (successful or not), and for each transition (transition state job) is evaluated on the returned items state, and which can modify it.

Some control over the queue can be achieved by specifying manage which is called on the queue after it changed and must return an updated queue. Newest items are at the end of the queue.

The item function to actually execute the requests can also be explicitly set; it defaults to execute.

Returns an item that manages execution of Ajax requests in its
local state. Use [[deliver]] to get an action that can be emitted by
`item` that adds a new delivery job to an internal queue.

Jobs transition from a :pending state, over :running
into :completed (successful or not), and for each transition `(transition
state job)` is evaluated on the returned items state, and which can modify it.

Some control over the queue can be achieved by specifying `manage`
which is called on the queue after it changed and must return an
updated queue. Newest items are at the end of the queue.

The item function to actually execute the requests can also be
explicitly set; it defaults to [[execute]].

source raw docstring

delivery-job!^cljs

(delivery-job! req & [info])

Returns a new delivery job, that you can put into the state backing up a [[delivery-queue]].

Returns a new delivery job, that you can put into the state backing
up a [[delivery-queue]].

source raw docstring

delivery-job-id^cljs

(delivery-job-id rec__14265__auto__)

(delivery-job-id data__14266__auto__ v__14267__auto__)

Lens for the id field from a DeliveryJob record. See reacl-c-basics.ajax/make-delivery-job.

Lens for the `id` field from a [[DeliveryJob]] record. See [[reacl-c-basics.ajax/make-delivery-job]].

source raw docstring

delivery-job-info^cljs

(delivery-job-info rec__14265__auto__)

(delivery-job-info data__14266__auto__ v__14267__auto__)

Lens for the info field from a DeliveryJob record. See reacl-c-basics.ajax/make-delivery-job.

Lens for the `info` field from a [[DeliveryJob]] record. See [[reacl-c-basics.ajax/make-delivery-job]].

source raw docstring

delivery-job-request^cljs

(delivery-job-request rec__14265__auto__)

(delivery-job-request data__14266__auto__ v__14267__auto__)

Lens for the req field from a DeliveryJob record. See reacl-c-basics.ajax/make-delivery-job.

Lens for the `req` field from a [[DeliveryJob]] record. See [[reacl-c-basics.ajax/make-delivery-job]].

source raw docstring

delivery-job-response^cljs

(delivery-job-response rec__14265__auto__)

(delivery-job-response data__14266__auto__ v__14267__auto__)

Lens for the response field from a DeliveryJob record. See reacl-c-basics.ajax/make-delivery-job.

Lens for the `response` field from a [[DeliveryJob]] record. See [[reacl-c-basics.ajax/make-delivery-job]].

source raw docstring

delivery-job-status^cljs

(delivery-job-status rec__14265__auto__)

(delivery-job-status data__14266__auto__ v__14267__auto__)

Lens for the status field from a DeliveryJob record. See reacl-c-basics.ajax/make-delivery-job.

Lens for the `status` field from a [[DeliveryJob]] record. See [[reacl-c-basics.ajax/make-delivery-job]].

source raw docstring

delivery-job?^cljs

(delivery-job? thing)

Is object a DeliveryJob record? See reacl-c-basics.ajax/make-delivery-job.

Is object a `DeliveryJob` record? See [[reacl-c-basics.ajax/make-delivery-job]].

source raw docstring

DeliveryJob^cljs

source

error-response^cljs

(error-response status & [body])

source

execute^cljs

(execute request)

source

fetch^cljs

(fetch req)

Returns an invisible item, that will execute the given request whenever its state is or becomes nil, and set its state to the success or error response as soon as available.

Returns an invisible item, that will
execute the given request whenever its state is or becomes nil, and
set its state to the success or error response as soon as
available.

source raw docstring

fetch-once^cljs

(fetch-once req f)

Returns an invisible item, that will execute the given Ajax request once, when mounted. When the request completes with an error or success, then (f state response) is evaluated, which must return a [[reacl-c.core/return]] value.

Returns an invisible item, that will execute the given Ajax
request once, when mounted. When the request completes with an error
or success, then `(f state response)` is evaluated, which must
return a [[reacl-c.core/return]] value.

source raw docstring

fetch-when^cljs

(fetch-when req cond)

Returns an invisible item, that will execute the given request once if cond is true, and also whenever cond changes from false to true. Updates its state to the response value after each request completed (successful or not).

Returns an invisible item, that will execute the given request once
if `cond` is true, and also whenever `cond` changes from false to
true. Updates its state to the response value after each request
completed (successful or not).

source raw docstring

fetch-when+state^cljs

(fetch-when+state req cond)

Returns an invisible item, that will execute the given request once if cond is true, and also whenever cond changes from false to true. Updates its state to a tuple of the response and a loading flag:

true when a request is started, but hasn't completed yet
false when a request is completed. Initialize the state to false or nil.

Returns an invisible item, that will execute the given request once
if `cond` is true, and also whenever `cond` changes from false to
true. Updates its state to a tuple of the response and a loading flag:
- `true` when a request is started, but hasn't completed yet
- `false` when a request is completed.
Initialize the state to false or nil.

source raw docstring

GET^cljs

(GET uri & [options])

source

HEAD^cljs

(HEAD uri & [options])

source

make-delivery-job^cljs

(make-delivery-job id req info status response)

Construct a DeliveryJob record.

id: access via reacl-c-basics.ajax/delivery-job-id req: access via reacl-c-basics.ajax/delivery-job-request info: access via reacl-c-basics.ajax/delivery-job-info status: access via reacl-c-basics.ajax/delivery-job-status response: access via reacl-c-basics.ajax/delivery-job-response

Construct a `DeliveryJob` record.

`id`: access via [[reacl-c-basics.ajax/delivery-job-id]]
`req`: access via [[reacl-c-basics.ajax/delivery-job-request]]
`info`: access via [[reacl-c-basics.ajax/delivery-job-info]]
`status`: access via [[reacl-c-basics.ajax/delivery-job-status]]
`response`: access via [[reacl-c-basics.ajax/delivery-job-response]]

source raw docstring

make-request^cljs

(make-request f uri options)

Construct a Request record.

f: access via reacl-c-basics.ajax/request-f uri: access via reacl-c-basics.ajax/request-uri options: access via reacl-c-basics.ajax/request-options

Construct a `Request` record.

`f`: access via [[reacl-c-basics.ajax/request-f]]
`uri`: access via [[reacl-c-basics.ajax/request-uri]]
`options`: access via [[reacl-c-basics.ajax/request-options]]

source raw docstring

make-response^cljs

(make-response ok? value)

Construct a Response record.

ok?: access via reacl-c-basics.ajax/response-ok? value: access via reacl-c-basics.ajax/response-value

Construct a `Response` record.

`ok?`: access via [[reacl-c-basics.ajax/response-ok?]]
`value`: access via [[reacl-c-basics.ajax/response-value]]

source raw docstring

map-ok-response^cljs

(map-ok-response req f & args)

Convert the response-value to the given request through a call to (f response & args) if it's an ok response.

Convert the [[response-value]] to the given request through a
call to `(f response & args)` if it's an ok response.

source raw docstring

map-response^cljs

(map-response req f & args)

Convert the response to the given request through a call to (f response & args).

Convert the response to the given request through a call to `(f response & args)`.

source raw docstring

maybe-show-response-value^cljs

(maybe-show-response-value resp e-pending f-ok & [f-error])

source

ok-response^cljs

(ok-response result)

source

OPTIONS^cljs

(OPTIONS uri & [options])

source

PATCH^cljs

(PATCH uri & [options])

source

POST^cljs

(POST uri & [options])

source

PURGE^cljs

(PURGE uri & [options])

source

PUT^cljs

(PUT uri & [options])

source

Request^cljs

source

request-f^cljs

(request-f rec__14265__auto__)

(request-f data__14266__auto__ v__14267__auto__)

Lens for the f field from a Request record. See reacl-c-basics.ajax/make-request.

Lens for the `f` field from a [[Request]] record. See [[reacl-c-basics.ajax/make-request]].

source raw docstring

request-options^cljs

(request-options rec__14265__auto__)

(request-options data__14266__auto__ v__14267__auto__)

Lens for the options field from a Request record. See reacl-c-basics.ajax/make-request.

Lens for the `options` field from a [[Request]] record. See [[reacl-c-basics.ajax/make-request]].

source raw docstring

request-uri^cljs

(request-uri rec__14265__auto__)

(request-uri data__14266__auto__ v__14267__auto__)

Lens for the uri field from a Request record. See reacl-c-basics.ajax/make-request.

Lens for the `uri` field from a [[Request]] record. See [[reacl-c-basics.ajax/make-request]].

source raw docstring

request?^cljs

(request? thing)

Is object a Request record? See reacl-c-basics.ajax/make-request.

Is object a `Request` record? See [[reacl-c-basics.ajax/make-request]].

source raw docstring

Response^cljs

source

response-ok?^cljs

(response-ok? rec__14265__auto__)

(response-ok? data__14266__auto__ v__14267__auto__)

Lens for the ok? field from a Response record. See reacl-c-basics.ajax/make-response.

Lens for the `ok?` field from a [[Response]] record. See [[reacl-c-basics.ajax/make-response]].

source raw docstring

response-value^cljs

(response-value rec__14265__auto__)

(response-value data__14266__auto__ v__14267__auto__)

Lens for the value field from a Response record. See reacl-c-basics.ajax/make-response.

Lens for the `value` field from a [[Response]] record. See [[reacl-c-basics.ajax/make-response]].

source raw docstring

response?^cljs

(response? thing)

Is object a Response record? See reacl-c-basics.ajax/make-response.

Is object a `Response` record? See [[reacl-c-basics.ajax/make-response]].

source raw docstring

show-response-value^cljs

(show-response-value resp f-ok & [f-error])

source

throw-response-error^cljs

(throw-response-error error)

source

TRACE^cljs

(TRACE uri & [options])

source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close