Update naming convention to H suffix

Author: JordanMartinez

src/Node/EventEmitter.purs

@@ -21,8 +21,9 @@
 -- | ```
 -- | data Color = Red | Green | Blue
 -- |
--- | barHandle :: EventHandle Foo (Maybe Error -> Color -> Effect Unit) (EffectFn1 (Nullable Error) String Unit)
--- | barHandle = EventHandle "bar" $ \psCb -> mkEffectFn2 \nullableError str ->
+-- | -- Note: see docs on `EventHandle` for the below naming convention justification of suffixing `H`.
+-- | barH :: EventHandle Foo (Maybe Error -> Color -> Effect Unit) (EffectFn1 (Nullable Error) String Unit)
+-- | barH = EventHandle "bar" $ \psCb -> mkEffectFn2 \nullableError str ->
 -- |   psCb (toMaybe nullableError) case str of
 -- |     "red" -> Red
 -- |     "green" -> Green
@@ -48,8 +49,8 @@ module Node.EventEmitter
   , setUnlimitedListeners
   , unsafeEmitFn
   , EventHandle(..)
-  , newListenerHandle
-  , removeListenerHandle
+  , newListenerH
+  , removeListenerH
   , on
   , on_
   , once
@@ -139,20 +140,23 @@ foreign import unsafeEmitFn :: forall f. EventEmitter -> f Boolean
 -- | Packs all the type information we need to call `on`/`once`/`prependListener`/`prependOnceListener`
 -- | with the correct callback function type.
 -- |
--- | Naming convention: If the name of an event is `foo`, 
--- | the corresponding PureScript `EventHandle` value should be called `fooHandle`.
+-- | **Naming convention**: If the name of an event is `foo`, 
+-- | the corresponding PureScript `EventHandle` value should be called `fooH`.
+-- | The `H` suffix is what prevent name conflicts in two situations:
+-- | 1. similarly-named methods (e.g. the `"close"` event and the `close` method)
+-- | 2. PureScript keywords (e.g. the `"data"` event)
 data EventHandle :: Type -> Type -> Type -> Type
 data EventHandle emitterType pureScriptCallback javaScriptCallback =
   EventHandle String (pureScriptCallback -> javaScriptCallback)
 
 type role EventHandle representational representational representational
 
-newListenerHandle :: EventHandle EventEmitter (Either JsSymbol String -> Effect Unit) (EffectFn1 SymbolOrStr Unit)
-newListenerHandle = EventHandle "newListener" $ \cb -> mkEffectFn1 \jsSymbol ->
+newListenerH :: EventHandle EventEmitter (Either JsSymbol String -> Effect Unit) (EffectFn1 SymbolOrStr Unit)
+newListenerH = EventHandle "newListener" $ \cb -> mkEffectFn1 \jsSymbol ->
   cb $ runFn3 symbolOrStr Left Right jsSymbol
 
-removeListenerHandle :: EventHandle EventEmitter (Either JsSymbol String -> Effect Unit) (EffectFn1 SymbolOrStr Unit)
-removeListenerHandle = EventHandle "removeListener" $ \cb -> mkEffectFn1 \jsSymbol ->
+removeListenerH :: EventHandle EventEmitter (Either JsSymbol String -> Effect Unit) (EffectFn1 SymbolOrStr Unit)
+removeListenerH = EventHandle "removeListener" $ \cb -> mkEffectFn1 \jsSymbol ->
   cb $ runFn3 symbolOrStr Left Right jsSymbol
 
 -- | Adds the listener to the **end** of the `listeners` array.

test/Test/Node/EventEmitter.purs

@@ -13,8 +13,8 @@ import Node.EventEmitter.UtilTypes (EventHandle1)
 import Test.Spec (Spec, describe, it)
 import Test.Spec.Assertions (shouldEqual)
 
-fooHandle :: EventHandle1 EventEmitter String
-fooHandle = EventHandle "foo" mkEffectFn1
+fooH :: EventHandle1 EventEmitter String
+fooH = EventHandle "foo" mkEffectFn1
 
 spec :: Spec Unit
 spec = describe "event-emitter" do
@@ -42,7 +42,7 @@ spec = describe "event-emitter" do
           let expected = "bar"
           ref <- Ref.new ""
           ee <- EventEmitter.new
-          ee # fn fooHandle \val -> do
+          ee # fn fooH \val -> do
             Ref.write val ref
           void $ runEffectFn2 (unsafeEmitFn ee) "foo" expected
           val <- Ref.read ref
@@ -62,7 +62,7 @@ spec = describe "event-emitter" do
           let expected = "bar"
           ref <- Ref.new ""
           ee <- EventEmitter.new
-          void $ ee # fn fooHandle \val -> do
+          void $ ee # fn fooH \val -> do
             Ref.write val ref
           void $ runEffectFn2 (unsafeEmitFn ee) "foo" expected
           val <- Ref.read ref
@@ -72,7 +72,7 @@ spec = describe "event-emitter" do
         liftEffect do
           ref <- Ref.new ""
           ee <- EventEmitter.new
-          remove <- ee # fn fooHandle \val -> do
+          remove <- ee # fn fooH \val -> do
             Ref.write val ref
           remove
           void $ runEffectFn2 (unsafeEmitFn ee) "foo" "bar"