urania.core — oliyh/urania 0.1.2

AST clj/s≠ protocol

-done? clj/s

(-done? this)

-children clj/s

(-children this)

-inject clj/s

(-inject this env)

BatchedSource clj/s≠ protocol

A remote data source that can be fetched in batches.

-fetch-multi clj/s

(-fetch-multi this resources env)

Fetch this and other data sources in a single batch. The returned promise must be a map from the data source identities to their results.

Cache clj/s≠ protocol

A lookup for previously fetched responses

-get clj/s

(-get this resource-name cache-id not-found)

-into clj/s

(-into this responses-by-resource-name)

cache-id clj/s

(cache-id res)

collect clj/s

(collect muses)

Given a collection of data sources, return a new data source that will contain a collection with the values of every data source when fetched.

ComposedAST clj/s≠ protocol

-compose-ast clj/s

(-compose-ast this f)

DataSource clj/s≠ protocol

A remote data source.

-fetch clj/s

(-fetch this env)

Fetch this data source

-identity clj/s

(-identity this)

Return an identifier for this data source. Used for caching, note that data sources of different types are cached separately.

default-executor clj/s

Done cljs

execute! clj/s

(execute! ast)

(execute! ast opts)

Executes the data fetching, returning a promise of the [cache result] pair.

• fetch data sources concurrently (when possible)
• cache result of previously made fetches
• batch calls to the same data source (when applicable)

You can pass a second argument with the following options:

• :cache: A map to use as the cache.

• :executor: An implementation of IExecutor that will be used to run the fetches. Defaults to urania.core/default-executor.

In Clojure you can pass a java.util.concurrent.Executor instance.

• :env: An environment that will be passed to every data fetching function.

FlatMap cljs

IExecutor clj/s≠ protocol

A policy for executing tasks.

-execute clj/s

(-execute ex task)

Perform a task.

map clj/s

(map f muse & muses)

Given a function and one or more data sources, return a new data source that will apply the given function to the results. When mapping over multiple data sources the results will be passed as positional arguments to the given function.

Map cljs

mapcat clj/s

(mapcat f muse & muses)

Given a function and one or more data sources, return a new data source that will apply the given function to the results. The function is assumed to return more data sources that will be flattened into a single data source.

resource-name clj/s

(resource-name v)

run! clj/s

(run! ast)

(run! ast opts)

Executes the data fetching, returning a promise of the result.

• fetch data sources concurrently (when possible)
• cache result of previously made fetches
• batch calls to the same data source (when applicable)

You can pass a second argument with the following options:

• :cache: A map to use as the cache.

• :executor: An implementation of IExecutor that will be used to run the fetches. Defaults to urania.core/default-executor.

In Clojure you can pass a java.util.concurrent.Executor instance.

• :env: An environment that will be passed to every data fetching function.

run!! clj

(run!! ast)

(run!! ast opts)

Dereferences the the promise returned by run!, blocking until a result is available.

Not implemented on ClojureScript.

run-defaults clj/s

traverse clj/s

(traverse f muses)

Given a function and a collection of data sources, apply the function once to each data source and collect the resulting data source results into a data source with every result.

value clj/s

(value v)

Given a plain value, wrap it in a data source that will return the value immediately.

Value cljs