unifier.response — clj-unifier 0.0.7

A Clojure(Script) library for unified responses.

-> clj/s macro

(-> expr & forms)

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

->> clj/s macro

(->> expr & forms)

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

?-> clj/s macro

(?-> & forms)

The safe version of the macro -> (the thread-first macro).

?->> clj/s macro

(?->> & forms)

The safe version of the macro ->> (the thread-last macro).

as-accepted clj/s

(as-accepted data)

(as-accepted data meta)

Returns unified ::accepted response. Instance of unifier.response/UnifiedSuccess.

as-busy clj/s

(as-busy data)

(as-busy data meta)

Returns unified ::busy response. Instance of unifier.response/UnifiedError.

as-conflict clj/s

(as-conflict data)

(as-conflict data meta)

Returns unified ::conflict response. Instance of unifier.response/UnifiedError.

as-created clj/s

(as-created data)

(as-created data meta)

Returns unified ::accepted response. Instance of unifier.response/UnifiedSuccess.

as-error clj/s

(as-error data)

(as-error data meta)

(as-error type data meta)

Returns unified ::error response. Instance of unifier.response/UnifiedError. Examples:

• with default error type (as-error "a user was not found")

• with specified error type (as-error :user/not-found "a user was not found")

• with specified error type and meta (as-error :user/not-found "[e-mail]" {:i18n/key :user/not-found})

as-exception clj/s

(as-exception data)

(as-exception data meta)

Returns unified ::exception response. Instance of unifier.response/UnifiedError.

as-fault clj/s

(as-fault data)

(as-fault data meta)

Returns unified ::fault response. Instance of unifier.response/UnifiedError.

as-forbidden clj/s

(as-forbidden data)

(as-forbidden data meta)

Returns unified ::forbidden response. Instance of unifier.response/UnifiedError.

as-incorrect clj/s

(as-incorrect data)

(as-incorrect data meta)

Returns unified ::incorrect response. Instance of unifier.response/UnifiedError.

as-interrupted clj/s

(as-interrupted data)

(as-interrupted data meta)

Returns unified ::interrupted response. Instance of unifier.response/UnifiedError.

as-not-found clj/s

(as-not-found data)

(as-not-found data meta)

Returns unified ::not-found response. Instance of unifier.response/UnifiedError.

as-ok clj/s

(as-ok data)

(as-ok data meta)

Returns unified ::ok response. Instance of unifier.response/UnifiedSuccess.

as-success clj/s

(as-success data)

(as-success data meta)

(as-success type data meta)

Returns instance of unifier.response/UnifiedSuccess. Examples:

• with default success type (as-success "a user was created successfully")

• with specified success type (as-success :user/created "a user was created successfully")

• with specified success type and meta (as-success :user/created "a user was created successfully" {:i18n/key :user/created})

as-unavailable clj/s

(as-unavailable data)

(as-unavailable data meta)

Returns unified ::unavailable response. Instance of unifier.response/UnifiedError.

as-unknown clj/s

(as-unknown data)

(as-unknown data meta)

Returns unified ::unknown response. Instance of unifier.response/UnifiedError.

as-unsupported clj/s

(as-unsupported data)

(as-unsupported data meta)

Returns unified ::unsupported response. Instance of unifier.response/UnifiedError.

as-warning clj/s

(as-warning data)

(as-warning data meta)

Returns unified ::warning response. Instance of unifier.response/UnifiedError.

cljs? clj

(cljs? env)

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

error-types clj/s

Common error types.

error? clj/s

(error? x)

Returns true if the given value is instance of unifier.response/UnifiedError. Otherwise false.

get-data clj/s

(get-data x)

Returns data of response.

get-meta clj/s

(get-meta x)

Returns meta of response.

get-type clj/s

(get-type x)

Returns type of response.

IUnifiedResponse clj/s≠ protocol

-get-meta clj/s

(-get-meta _)

Returns meta of response.

-error? clj/s

(-error? _)

Returns true if the given value is instance of unifier.response/UnifiedError. Otherwise false.

-success? clj/s

(-success? _)

Returns true if the given value is instance of unifier.response/UnifiedSuccess. Otherwise false.

-set-data clj/s

(-set-data _ data)

Sets data of response.

-set-type clj/s

(-set-type _ type)

Sets type of response.

-set-meta clj/s

(-set-meta _ meta)

Sets meta of response.

-get-type clj/s

(-get-type _)

Returns type of response.

-response? clj/s

(-response? _)

Returns true if the given value is implements unifier.response/IUnifiedResponse protocol. Otherwise false.

-get-data clj/s

(-get-data _)

Returns data of response.

response? clj/s

(response? x)

Returns true if the given value is implements unifier.response/IUnifiedResponse protocol. Otherwise false.

safe clj/s macro

(safe body)

(safe body handler)

Extended version of try-catch.

set-data clj/s

(set-data x data)

Sets data of response.

set-meta clj/s

(set-meta x meta)

Sets meta of response.

set-type clj/s

(set-type x type)

Sets type of response.

success-types clj/s

Common success types.

success? clj/s

(success? x)

Returns true if the given value is instance of unifier.response/UnifiedSuccess. Otherwise false.

UnifiedError cljs

UnifiedSuccess cljs

unwrap clj/s

(unwrap response)

Returns unwrapped unified response (as map).