fix: update comments

and keep comments

.gitignore

@@ -42,6 +42,8 @@ node_modules
 .idea
 
 # project folders
+cjs
 dist*
+esm
 lib
 out*

package.json

@@ -37,7 +37,7 @@
     "depcheck": "yarn dependency-check",
     "dependency-check": "run-p dependency-check:unused dependency-check:missing",
     "dependency-check:missing": "dependency-check . --missing --no-dev",
-    "dependency-check:unused": "dependency-check . --unused --no-dev -i typescript",
+    "dependency-check:unused": "dependency-check . --unused --no-dev -i flux-standard-action -i @types/fbemitter -i type-plus",
     "lint": "eslint --ext=ts,js .",
     "nuke": "yarn clean && rimraf node_modules",
     "release": "npx semantic-release",

ts/Emitter.ts

@@ -19,10 +19,13 @@ export class Emitter {
     if (this.listenMisses.length > 0 && this.emitter.listeners(type).length === 0)
       this.listenMisses.forEach(l => l({ type, payload, meta, error }))
   }
-
+  /**
+   * @param event TypedEvent created from `createEvent` or the event type in string.
+   */
   addListener<Payload, Meta>(
     event: TypedEvent<Payload, Meta> | string,
-    listener: (payload: Payload, meta: Meta, error: boolean) => void): EventSubscription {
+    listener: (payload: Payload, meta: Meta, error: boolean) => void
+  ): EventSubscription {
     const type = typeof event === 'string' ? event : event.type
     if (type === errorEvent.type)
       return this.addErrorEventListener(listener)
@@ -37,17 +40,26 @@ export class Emitter {
     }
     return this.emitter.addListener(type, wrappedListener)
   }
-  on<Payload, Meta>(event: TypedEvent<Payload, Meta> | string, listener: (payload: Payload, meta: Meta, error: boolean) => void): EventSubscription {
+  on<Payload, Meta>(
+    event: TypedEvent<Payload, Meta> | string,
+    listener: (payload: Payload, meta: Meta, error: boolean) => void
+  ): EventSubscription {
     return this.addListener(event, listener)
   }
-  once<Payload, Meta>(event: TypedEvent<Payload, Meta> | string, listener: (payload: Payload, meta: Meta, error: boolean) => void): EventSubscription {
+  once<Payload, Meta>(
+    event: TypedEvent<Payload, Meta> | string,
+    listener: (payload: Payload, meta: Meta, error: boolean) => void
+  ): EventSubscription {
     const type = typeof event === 'string' ? event : event.type
     return this.emitter.once(type, listener)
   }
   /**
    * Gets into a queue and listen to one event.
    */
-  queue<Payload, Meta>(event: TypedEvent<Payload, Meta> | string, listener: (payload: Payload, meta: Meta, error: boolean) => void): EventSubscription {
+  queue<Payload, Meta>(
+    event: TypedEvent<Payload, Meta> | string,
+    listener: (payload: Payload, meta: Meta, error: boolean) => void
+  ): EventSubscription {
     const type = typeof event === 'string' ? event : event.type
     const queue = this.eventQueues[type] = this.eventQueues[type] || []
     const wrap = (payload: Payload, meta: Meta, error: boolean) => {
@@ -93,7 +105,9 @@ export class Emitter {
     }
   }
 
-  protected addErrorEventListener<Payload, Meta>(listener: (payload: Payload, meta: Meta, error: boolean) => void): EventSubscription {
+  protected addErrorEventListener<Payload, Meta>(
+    listener: (payload: Payload, meta: Meta, error: boolean) => void
+  ): EventSubscription {
     const wrappedListener = (payload: Payload, meta: Meta, error: boolean) => {
       try {
         listener(payload, meta, error)

ts/TestEmitter.ts

@@ -68,7 +68,9 @@ export class TestEmitter extends Emitter {
     return this.listenedToEventArray(keys.map(k => events[k]))
   }
 
-  protected addErrorEventListener<Payload, Meta>(listener: (payload: Payload, meta: Meta, error: boolean) => void): EventSubscription {
+  protected addErrorEventListener<Payload, Meta>(
+    listener: (payload: Payload, meta: Meta, error: boolean) => void
+  ): EventSubscription {
     return this.emitter.addListener(errorEvent.type, listener)
   }
 }

ts/createEvent.spec.ts

@@ -4,11 +4,11 @@ import { isFSA, isError } from 'flux-standard-action'
 import { createEvent, createScopedCreateEvent } from './index'
 
 test('empty eventCreator creates FSA compliant action', () => {
-  const blip = createEvent('blip')
+  const beep = createEvent('beep')
 
   // want undefined parameters optional
   // waiting for https://github.com/Microsoft/TypeScript/issues/12400
-  t(isFSA(blip(undefined, undefined)))
+  t(isFSA(beep(undefined, undefined)))
 })
 
 test('eventCreator with payload creates FSA compliant action', () => {

ts/createEvent.ts

@@ -15,7 +15,13 @@ export function createScopedCreateEvent(scope: string): typeof createEvent {
   return (type) => createEvent(`${scope}/${type}`)
 }
 
-export function createEvent<Payload = undefined, Meta = undefined>(type: string, isError: ((payload: Payload) => boolean) | boolean = defaultIsErrorPredicate): Event<Payload, Meta> {
+export function createEvent<
+  Payload = undefined,
+  Meta = undefined
+>(
+  type: string,
+  isError: ((payload: Payload) => boolean) | boolean = defaultIsErrorPredicate
+): Event<Payload, Meta> {
   return Object.assign(
     (payload: Payload, meta: Meta) => {
       return isError && (typeof isError === 'boolean' || isError(payload)) ?

ts/setupCommandTest.ts

@@ -2,7 +2,10 @@ import { Command } from './Command'
 import { Emitter } from './Emitter'
 import { TestEmitter } from './TestEmitter'
 
-export function setupCommandTest<Cmd extends Command, Args extends any[]>(Command: new (emitter: Emitter, ...args: Args) => Cmd, ...args: Args) {
+export function setupCommandTest<Cmd extends Command, Args extends any[]>(
+  Command: new (emitter: Emitter, ...args: Args) => Cmd,
+  ...args: Args
+) {
   const emitter = new TestEmitter()
   const command = new Command(emitter, ...args)
   return { emitter, command }

tsconfig.base.json

@@ -8,7 +8,6 @@
     "newLine": "LF",
     "noUnusedLocals": true,
     "noUnusedParameters": false,
-    "removeComments": true,
     "sourceMap": true,
     "strict": true,
     "stripInternal": true,