ninja.unifier.response — ninja.anywhere/unifier 1.0.0

A Clojure(Script) library for unified responses.

*default-error-http-status* clj/s

Default http status for unified error response.

*default-http-response* clj/s

Default http response.

*default-http-statuses* clj/s

Map of unified response types associated with http statuses.

*default-success-http-status* clj/s

Default http status for unified success response.

as-accepted clj/s

(as-accepted x)

(as-accepted x meta)

Returns unified accepted response.

as-busy clj/s

(as-busy x)

(as-busy x meta)

Returns unified busy response.

as-conflict clj/s

(as-conflict x)

(as-conflict x meta)

Returns unified conflict response.

as-created clj/s

(as-created x)

(as-created x meta)

Returns unified created response.

as-deleted clj/s

(as-deleted x)

(as-deleted x meta)

Returns unified deleted response.

as-error clj/s

(as-error x)

(as-error x meta)

Returns unified error response.

as-exception clj/s

(as-exception x)

(as-exception x meta)

Returns unified exception response.

as-forbidden clj/s

(as-forbidden x)

(as-forbidden x meta)

Returns unified forbidden response.

as-http clj/s

(as-http x)

(as-http x overrides)

Returns a unified response as http response. If the given value is not unified response returns nil.

as-incorrect clj/s

(as-incorrect x)

(as-incorrect x meta)

Returns unified incorrect response.

as-interrupted clj/s

(as-interrupted x)

(as-interrupted x meta)

Returns unified interrupted response.

as-map clj/s

(as-map x)

Returns a unified response as a map. If the given value is not unified response returns nil.

as-not-found clj/s

(as-not-found x)

(as-not-found x meta)

Returns unified not-found response.

as-response clj/s

(as-response x {:keys [error? type meta]})

Returns unified response.

as-success clj/s

(as-success x)

(as-success x meta)

Returns unified success response.

as-unauthorized clj/s

(as-unauthorized x)

(as-unauthorized x meta)

Returns unified unauthorized response.

as-unavailable clj/s

(as-unavailable x)

(as-unavailable x meta)

Returns unified unavailable response.

as-unknown clj/s

(as-unknown x)

(as-unknown x meta)

Returns unified unknown response.

as-unsupported clj/s

(as-unsupported x)

(as-unsupported x meta)

Returns unified unsupported response.

as-warning clj/s

(as-warning x)

(as-warning x meta)

Returns unified warning response.

cljs? clj

(cljs? env)

Checks &env in macro and returns true if that cljs env. Otherwise false.

error? clj/s

(error? x)

Returns true if the given value is unified error response. Otherwise false.

meta clj/s

(meta x)

Returns meta of unified response. Otherwise nil.

not-error-> clj/s macro

(not-error-> expr & forms)

This macro is the same as clojure.core/some->, but the check is done using the predicate error? of the UnifiedResponse protocol and the substitution occurs as in macro -> (the thread-first macro).

not-error->> clj/s macro

(not-error->> expr & forms)

This macro is the same as clojure.core/some->>, but the check is done using the predicate error? of the UnifiedResponse protocol and the substitution occurs as in macro ->> (the thread-last macro).

response? clj/s

(response? x)

Returns true if the given value is unified response. Otherwise false.

to-http clj/s

(to-http x)

(to-http x overrides)

Converts unified response to the http response.

to-map clj/s

(to-map x)

Converts unified response to the map.

try-or clj/s macro

(try-or body)

(try-or body else)

Extended version of try-catch. Usage:

• (try-or (/ 1 0)) ;; => nil
• (try-or (/ 1 0) false) ;; => false
• (try-or (/ 1 0) #(prn (.getMessage %))) ;; => "Divide by zero"

type clj/s

(type x)

Returns type of unified response. Otherwise nil.

type->http-status clj/s

(type->http-status type error?)

Returns http status by the given unified response type. If type is not registered and error? is truthy returns *default-error-http-status*. Otherwise *default-success-http-status*.

UnifiedResponse clj/s protocol

UnifiedResponse protocol.

-as-http clj/s

(-as-http this)

(-as-http this overrides)

Returns a unified response as http response or nil if the given value is not a unified response.

-as-map clj/s

(-as-map this)

Returns a unified response as a map or nil if the given value is not a unified response.

-error? clj/s

(-error? this)

Returns true if the given value is unified error response. Otherwise false.

-meta clj/s

(-meta this)

Returns meta of unified response.

-response? clj/s

(-response? this)

Returns true if the given value is unified response. Otherwise false.

-type clj/s

(-type this)

Returns type of unified response.

with-default-http-error-status clj/s macro

(with-default-http-error-status default & body)

Overrides the default error http status.

with-default-http-response clj/s macro

(with-default-http-response default & body)

Overrides the default http response.

with-default-http-statuses clj/s macro

(with-default-http-statuses default & body)

Overrides the default http statuses.

with-default-success-http-status clj/s macro

(with-default-success-http-status default & body)

Overrides the default success http status.