Document host and script_name at endpoint

phlppn · Apr 18, 2020 · 7ece504 · 7ece504
1 parent e45ddd0
commit 7ece504
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/lib/phoenix/endpoint.ex b/lib/phoenix/endpoint.ex
@@ -290,6 +290,16 @@ defmodule Phoenix.Endpoint do
   """
   @callback static_lookup(path :: String.t) :: {String.t, String.t} | {String.t, nil}
 
+  @doc """
+  Returns the script name from the :url configuration.
+  """
+  @callback script_name() :: [String.t]
+
+  @doc """
+  Returns the host from the :url configuration.
+  """
+  @callback host() :: String.t
+
   # Channels
 
   @doc """

diff --git a/lib/phoenix/endpoint/supervisor.ex b/lib/phoenix/endpoint/supervisor.ex
@@ -410,9 +410,9 @@ defmodule Phoenix.Endpoint.Supervisor do
   Invoked to warm up caches on start and config change.
   """
   def warmup(endpoint) do
-    endpoint.host
+    endpoint.host()
+    endpoint.script_name()
     endpoint.path("/")
-    endpoint.script_name
     warmup_url(endpoint)
     warmup_static(endpoint)
     :ok