postal.client — funcool/postal 0.7.0

client cljs

(client url)

(client url
        {:keys [headers method params] :or {headers {} method :put params {}}})

Creates a new client instance from socket.

Client cljs

client? cljs

(client? client)

Return true if a privided client is instance of Client type.

decode cljs

(decode data)

encode cljs

(encode data)

novelty cljs

(novelty client dest)

(novelty client dest data)

(novelty client dest data opts)

Sends a novelty message to a server.

query cljs

(query client dest)

(query client dest data)

(query client dest data opts)

Sends a query message to a server.

reset-headers! cljs

(reset-headers! c headers)

Reset the headers on the client instance.

send! cljs

(send! client {:keys [type dest data headers] :as opts})

socket cljs

(socket client dest)

(socket client dest data)

(socket client dest data {:keys [params _type] :or {params {} _type :socket}})

Sends a :socket frame to the server and opens bi-direction websocket connection.

This function returns a vector of two streams, first for input messages and second for output.

You can close the socket just ending the output stream.

subscribe cljs

(subscribe client dest)

(subscribe client dest data)

(subscribe client dest data {:keys [params] :or {params {}} :as opts})

Sends a :subscribe frame to the server and open an uni-directional websocket connection.

This function returns one stream for read messages from backend. You can close the subscription sockets just ending the stream.

update-headers! cljs

(update-headers! c headers)

Update the headers on the client instance.