portal.api — djblue/portal 0.58.3

clear clj/s

(clear)

(clear portal)

Clear all values.

close clj/s

(close)

(close portal)

Close all current inspector windows.

• portal: Portal session returned via portal.api/open.

docs clj/s

(docs)

(docs options)

Open portal docs.

• options: see portal.api/open for options.

eval-str clj/s

(eval-str code)

(eval-str portal code)

(eval-str portal code opts)

Evaluate ClojureScript source given as a string in the UI runtime. The parameters:

• portal: portal instance returned from portal.api/open or :all
• code (string): the ClojureScript source
• opts (map): evaluation options.
  • :verbose (boolean) optional, return a map containing more info that just the value.
    • Defaults to false.
  • :await (boolean) optional, await a promise result.
    • Defaults to false.

inspect clj/s

(inspect value)

(inspect value options)

Open a new portal window to inspect a particular value.

• value: a value to inspect.
• options: see portal.api/open for options.

open clj/s

(open)

(open portal-or-options)

(open portal options)

Open a new inspector window. A previous instance can be passed as parameter to make sure it is open.

• options (map): open options.
  • :theme (keyword) theme to use for Portal UI, see portal.colors/themes for themes.
    • Themes are applied per UI instance, not globally.
  • :window-title (string) browser window title.
    • Useful for distinguishing multiple UI instances.
  • :app (boolean) Run in --app mode via chrome.
    • Defaults to true when chrome is installed.
    • Will use PWA at https://djblue.github.io/portal/ when installed.

register! clj/s

(register! var)

Register a var with portal. For now, the var should be a 1 arity fn.

Example:

(register! #'identity)

The function name and doc string will show up in the command palette.

repl clj/s

(repl)

(repl portal)

Start a repl for the given Portal session.

• portal: Portal session returned via portal.api/open

selected clj/s

(selected)

(selected session)

Get a sequence of all currently selected values.

sessions clj/s

(sessions)

Get all current portal sessions.

set-defaults! clj/s

(set-defaults! options)

Set default options for open and start. Parameters passed directly to either will override defaults.

start clj/s

(start options)

Start the HTTP server with non-default options. Only use if you need control over the HTTP server.

• options (map): start options.
  • :host (string) optional, server host to use for Portal server.
    • Ignored if server already started.
  • :port (number) optional, server port to use for Portal server.
    • Ignored if server already started.

stop clj/s

(stop)

Stop the HTTP server.

submit clj/s

(submit value)

Tap target function.

Usage:

(add-tap #'portal.api/submit)
(remove-tap #'portal.api/submit)

tap clj/s deprecated

(tap)

Add portal as a tap> target.

url clj/s

(url portal)

Get url for portal session.

• portal: Portal session returned via portal.api/open