Liking cljdoc? Tell your friends :D

com.stuartsierra.component


dependenciesclj/s

(dependencies component)

Returns the map of other components on which this component depends.

Returns the map of other components on which this component depends.
sourceraw docstring

dependency-graphclj/s

(dependency-graph system component-keys)

Returns a dependency graph, using the data structures defined in com.stuartsierra.dependency, for the components found by (select-keys system component-keys)

Returns a dependency graph, using the data structures defined in
com.stuartsierra.dependency, for the components found by
(select-keys system component-keys)
sourceraw docstring

ex-component?clj/s

(ex-component? error)

True if the error has ex-data indicating it was thrown by something in the com.stuartsierra.component namespace.

True if the error has ex-data indicating it was thrown by something
in the com.stuartsierra.component namespace.
sourceraw docstring

ex-without-componentsclj/s

(ex-without-components error)

If the error has ex-data provided by the com.stuartsierra.component namespace, returns a new exception instance with the :component and :system removed from its ex-data. Preserves the other details of the original error. If the error was not created by this namespace, returns it unchanged. Use this when you want to catch and rethrow exceptions without including the full component or system.

If the error has ex-data provided by the com.stuartsierra.component
namespace, returns a new exception instance with the :component
and :system removed from its ex-data. Preserves the other details of
the original error. If the error was not created by this namespace,
returns it unchanged. Use this when you want to catch and rethrow
exceptions without including the full component or system.
sourceraw docstring

Lifecycleclj/s≠protocol

startclj/s

(start component)

Begins operation of this component. Synchronous, does not return until the component is started. Returns an updated version of this component.

Begins operation of this component. Synchronous, does not return
until the component is started. Returns an updated version of this
component.

stopclj/s

(stop component)

Ceases operation of this component. Synchronous, does not return until the component is stopped. Returns an updated version of this component.

Ceases operation of this component. Synchronous, does not return
until the component is stopped. Returns an updated version of this
component.
source

start-systemclj/s

(start-system system)
(start-system system component-keys)

Recursively starts components in the system, in dependency order, assoc'ing in their dependencies along the way. component-keys is a collection of keys (order doesn't matter) in the system specifying the components to start, defaults to all keys in the system.

Recursively starts components in the system, in dependency order,
assoc'ing in their dependencies along the way. component-keys is a
collection of keys (order doesn't matter) in the system specifying
the components to start, defaults to all keys in the system.
sourceraw docstring

stop-systemclj/s

(stop-system system)
(stop-system system component-keys)

Recursively stops components in the system, in reverse dependency order. component-keys is a collection of keys (order doesn't matter) in the system specifying the components to stop, defaults to all keys in the system.

Recursively stops components in the system, in reverse dependency
order. component-keys is a collection of keys (order doesn't matter)
in the system specifying the components to stop, defaults to all
keys in the system.
sourceraw docstring

system-mapclj/s

(system-map & keyvals)

Returns a system constructed of key/value pairs. The system has default implementations of the Lifecycle 'start' and 'stop' methods which recursively start/stop all components in the system.

System maps print as nil to avoid overwhelming the printer with large objects. As a consequence, printed system maps cannot be 'read'. To disable this behavior and print system maps like normal records, call (remove-method clojure.core/print-method com.stuartsierra.component.SystemMap)

Returns a system constructed of key/value pairs. The system has
default implementations of the Lifecycle 'start' and 'stop' methods
which recursively start/stop all components in the system.

System maps print as nil to avoid overwhelming the printer
with large objects. As a consequence, printed system maps cannot be
'read'. To disable this behavior and print system maps like normal
records, call
(remove-method clojure.core/print-method com.stuartsierra.component.SystemMap)
sourceraw docstring

system-usingclj/s

(system-using system dependency-map)

Associates dependency metadata with multiple components in the system. dependency-map is a map of keys in the system to maps or vectors specifying the dependencies of the component at that key in the system, as per 'using'.

Associates dependency metadata with multiple components in the
system. dependency-map is a map of keys in the system to maps or
vectors specifying the dependencies of the component at that key in
the system, as per 'using'.
sourceraw docstring

SystemMapcljs

source

update-systemclj/s

(update-system system component-keys f & args)

Invokes (apply f component args) on each of the components at component-keys in the system, in dependency order. Before invoking f, assoc's updated dependencies of the component.

Invokes (apply f component args) on each of the components at
component-keys in the system, in dependency order. Before invoking
f, assoc's updated dependencies of the component.
sourceraw docstring

update-system-reverseclj/s

(update-system-reverse system component-keys f & args)

Like update-system but operates in reverse dependency order.

Like update-system but operates in reverse dependency order.
sourceraw docstring

usingclj/s

(using component dependencies)

Associates metadata with component describing the other components on which it depends. Component dependencies are specified as a map. Keys in the map correspond to keys in this component which must be provided by its containing system. Values in the map are the keys in the system at which those components may be found. Alternatively, if the keys are the same in both the component and its enclosing system, they may be specified as a vector of keys.

Associates metadata with component describing the other components
on which it depends. Component dependencies are specified as a map.
Keys in the map correspond to keys in this component which must be
provided by its containing system. Values in the map are the keys in
the system at which those components may be found. Alternatively, if
the keys are the same in both the component and its enclosing
system, they may be specified as a vector of keys.
sourceraw docstring

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

× close