Skip to content

Commit

Permalink
API
Browse files Browse the repository at this point in the history
  • Loading branch information
borkdude committed Jan 26, 2023
1 parent de0b743 commit 011c3dc
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Shell out in Clojure with simplicity and ease.



## <a name="babashka.process/$">`$`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L514-L544)
## <a name="babashka.process/$">`$`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L512-L542)
<a name="babashka.process/$"></a>
``` clojure

Expand All @@ -43,13 +43,13 @@ Convenience macro around [`process`](#babashka.process/process). Takes command a
be passed via metadata on the form or as a first map arg. Supports
interpolation via `~`

## <a name="babashka.process/*defaults*">`*defaults*`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L202-L207)
## <a name="babashka.process/*defaults*">`*defaults*`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L200-L205)
<a name="babashka.process/*defaults*"></a>

Dynamic var containing overridable default options. Use
`alter-var-root` to change permanently or `binding` to change temporarily.

## <a name="babashka.process/alive?">`alive?`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L628-L631)
## <a name="babashka.process/alive?">`alive?`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L626-L629)
<a name="babashka.process/alive?"></a>
``` clojure

Expand All @@ -59,7 +59,7 @@ Dynamic var containing overridable default options. Use

Returns `true` if the process is still running and false otherwise.

## <a name="babashka.process/check">`check`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L97-L117)
## <a name="babashka.process/check">`check`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L95-L115)
<a name="babashka.process/check"></a>
``` clojure

Expand All @@ -69,7 +69,7 @@ Returns `true` if the process is still running and false otherwise.

Takes a process, waits until is finished and throws if exit code is non-zero.

## <a name="babashka.process/destroy">`destroy`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L158-L163)
## <a name="babashka.process/destroy">`destroy`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L156-L161)
<a name="babashka.process/destroy"></a>
``` clojure

Expand All @@ -80,7 +80,7 @@ Takes a process, waits until is finished and throws if exit code is non-zero.
Destroys the process and returns the input arg. Takes process or map
with :proc (`java.lang.ProcessBuilder`).

## <a name="babashka.process/destroy-tree">`destroy-tree`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L167-L175)
## <a name="babashka.process/destroy-tree">`destroy-tree`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L165-L173)
<a name="babashka.process/destroy-tree"></a>
``` clojure

Expand All @@ -91,7 +91,7 @@ Destroys the process and returns the input arg. Takes process or map
Same as [[`destroy`](#babashka.process/destroy)](#babashka.process/destroy) but also destroys all descendants. JDK9+
only. Falls back to [[`destroy`](#babashka.process/destroy)](#babashka.process/destroy) on older JVM versions.

## <a name="babashka.process/exec">`exec`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L569-L597)
## <a name="babashka.process/exec">`exec`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L567-L595)
<a name="babashka.process/exec"></a>
``` clojure

Expand All @@ -103,7 +103,7 @@ Replaces the current process image with the process image specified
by the given path invoked with the given args. Works only in GraalVM
native images. Override the first argument using `:arg0`.

## <a name="babashka.process/parse-args">`parse-args`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L267-L312)
## <a name="babashka.process/parse-args">`parse-args`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L265-L310)
<a name="babashka.process/parse-args"></a>
``` clojure

Expand All @@ -118,7 +118,7 @@ Parses arguments to [`process`](#babashka.process/process) to map with:
* `:opts`: options map


## <a name="babashka.process/pb">`pb`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L314-L321)
## <a name="babashka.process/pb">`pb`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L312-L319)
<a name="babashka.process/pb"></a>
``` clojure

Expand All @@ -128,7 +128,7 @@ Parses arguments to [`process`](#babashka.process/process) to map with:

Returns a process builder (as record).

## <a name="babashka.process/pipeline">`pipeline`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L459-L493)
## <a name="babashka.process/pipeline">`pipeline`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L457-L491)
<a name="babashka.process/pipeline"></a>
``` clojure

Expand All @@ -147,7 +147,7 @@ Returns the processes for one pipe created with -> or creates
Also see [Pipelines](/README.md#pipelines).


## <a name="babashka.process/process">`process`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L394-L442)
## <a name="babashka.process/process">`process`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L392-L440)
<a name="babashka.process/process"></a>
``` clojure

Expand Down Expand Up @@ -201,7 +201,7 @@ Creates a child process. Takes a command (vector of strings or
running processes are cleaned up on shutdown.
- `:exit-fn`: a function which is executed upon exit. Receives process map as argument. Only supported in JDK11+.

## <a name="babashka.process/process*">`process*`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L331-L392)
## <a name="babashka.process/process*">`process*`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L329-L390)
<a name="babashka.process/process*"></a>
``` clojure

Expand All @@ -211,7 +211,7 @@ Creates a child process. Takes a command (vector of strings or

Same as with [`process`](#babashka.process/process) but called with parsed arguments (the result from [`parse-args`](#babashka.process/parse-args))

## <a name="babashka.process/sh">`sh`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L546-L556)
## <a name="babashka.process/sh">`sh`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L544-L554)
<a name="babashka.process/sh"></a>
``` clojure

Expand All @@ -224,7 +224,7 @@ Convenience function similar to `clojure.java.shell/sh` that sets
`cjs/sh` it does not check the exit code (this can be done with
[`check`](#babashka.process/check)).

## <a name="babashka.process/shell">`shell`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L605-L626)
## <a name="babashka.process/shell">`shell`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L603-L624)
<a name="babashka.process/shell"></a>
``` clojure

Expand All @@ -246,7 +246,7 @@ Convenience function around [`process`](#babashka.process/process) that was orig

Also see the [`shell`](#babashka.process/shell) entry in the babashka book [here](https://book.babashka.org/#_shell).

## <a name="babashka.process/start">`start`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L495-L501)
## <a name="babashka.process/start">`start`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L493-L499)
<a name="babashka.process/start"></a>
``` clojure

Expand All @@ -256,7 +256,7 @@ Convenience function around [`process`](#babashka.process/process) that was orig

Takes a process builder, calls start and returns a process (as record).

## <a name="babashka.process/tokenize">`tokenize`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L15-L64)
## <a name="babashka.process/tokenize">`tokenize`</a> [📃](https://github.com/babashka/process/blob/master/src/babashka/process.cljc#L15-L62)
<a name="babashka.process/tokenize"></a>
``` clojure

Expand Down

0 comments on commit 011c3dc

Please sign in to comment.