Skip to content

Add docs to api/get-runtime! warning about use at the REPL #1235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PEZ wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add docs to api/get-runtime! warning about use at the REPL #1235

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/main/shadow/cljs/devtools/api.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,12 @@
(keys)
(into #{})))

(defn get-runtime! []
(defn get-runtime!
"NB: The runtime object is too huge to print at the REPL.
* (api/get-runtime!) ; => will blow your REPL up
* (:config (api/get-runtime!)) ; => works just fine
* (:supervisor (api/get-runtime!)) ; => also blows the REPL up"
[]
(runtime/get-instance!))

(defn- get-or-start-worker [build-config opts]
Expand Down Expand Up @@ -690,4 +695,4 @@
(swap! results-ref update :out str text))
})

@results-ref)))
Comment on lines 697 to -693
Copy link
Copy Markdown
Author

@PEZ PEZ Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't delete this on purpose. I think it was the GitHub code “editor” that did it.

@results-ref)))