fix name option and client typespecs

mana-ethereum · Oct 1, 2018 · 43d6dba · 43d6dba
1 parent c8b8fcd
commit 43d6dba
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/lib/websockex.ex b/lib/websockex.ex
@@ -45,7 +45,7 @@ defmodule WebSockex do
   arity.
   """
 
-  @type client :: pid | :atom | {:via, module, atom}
+  @type client :: pid | atom | {:via, module, term} | {:global, term}
 
   @type frame ::
           :ping
@@ -92,14 +92,15 @@ defmodule WebSockex do
     callback is always invoked if an established connection is lost.
   - `:debug` - Options to set the debug options for `:sys.handle_debug`.
   - `:name` - An atom that the registers the process with name locally.
+    Can also be a `{:via, module, term}` or `{:global, term}` tuple.
 
   Other possible option values include: `t:WebSockex.Conn.connection_option/0`
   """
   @type option ::
           WebSockex.Conn.connection_option()
           | {:async, boolean}
           | {:debug, debug_opts}
-          | {:name, atom}
+          | {:name, atom | {:global, term} | {:via, module, term}}
           | {:handle_initial_conn_failure, boolean}
 
   @typedoc """