Liking cljdoc? Tell your friends :D

clj-docker-client.core


categoriesclj

(categories)
(categories version)

Returns the available categories.

Takes an optional API version for specific ones.

Returns the available categories.

Takes an optional API version for specific ones.
sourceraw docstring

clientclj

(client {:keys [category conn api-version] :as args})

Constructs a client for a specified category.

Returns the client.

Examples are: :containers, :images, etc

Constructs a client for a specified category.

Returns the client.

Examples are: :containers, :images, etc
sourceraw docstring

connectclj

(connect {:keys [uri]})

Connects to the provided :uri in the connection options.

Returns the connection.

The url must be fully qualified with the protocol. eg. unix:///var/run/docker.sock or https://my.docker.host:6375

Connects to the provided :uri in the connection options.

Returns the connection.

The url must be fully qualified with the protocol.
eg. unix:///var/run/docker.sock or https://my.docker.host:6375
sourceraw docstring

docclj

(doc {:keys [category api-version]} operation)

Returns the doc of the supplied category and operation

Returns the doc of the supplied category and operation
sourceraw docstring

invokeclj

(invoke {:keys [category conn api-version]} {:keys [op params as-stream?]})

Performs the operation with the specified client and a map of options.

Returns the resulting map.

For the body parsing, checks if the user has supplied only one body param, and if its an InputStream, make it the body.

Performs the operation with the specified client and a map of options.

Returns the resulting map.

For the body parsing, checks if the user has supplied only one body param,
and if its an InputStream, make _it_ the body.
sourceraw docstring

opsclj

(ops client)

Returns the supported ops for a client.

Returns the supported ops for a client.
sourceraw docstring

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

× close