Type alias APIEvents

APIEvents: {
    close: ((err?) => void);
    error: ((err) => void);
    start-server: ((err?) => void);
    stop-server: ((err?) => void);
}

Type declaration

close: ((err?) => void)
- - (err?): void
  - Fires when the api is finally closed.
    Parameters
    - Optional err: any
    Returns void
error: ((err) => void)
- - (err): void
  - Fires when an error occurs.
    Parameters
    - err: Error | any
    Returns void
start-server: ((err?) => void)
- - (err?): void
  - Fires when the http server starts listening to incoming requests.
    Parameters
    - Optional err: Error
    Returns void
stop-server: ((err?) => void)
- - (err?): void
  - Fires when the http server starts stops to incoming requests.
    Parameters
    - Optional err: any
    Returns void

Generated using TypeDoc