Skip to content

Commit

Permalink
chore: apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Neil Campbell <[email protected]>
  • Loading branch information
aorumbayev and neilcampbell authored Sep 27, 2024
1 parent 9525840 commit df46204
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/capabilities/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ Refer to the [algokit-utils-ts-debug](https://github.com/algorandfoundation/algo

> Note: Config also contains a set flags that affect behaviour of [algokit-utils-ts-debug](https://github.com/algorandfoundation/algokit-utils-ts-debug). Those include `projectRoot`, `traceAll`, `traceBufferSizeMb`, and `maxSearchDepth`. Refer to addon package documentation for details.
### Why debug utilities are in a separate package?
### Why are the debug utilities in a separate package?

To keep the `algokit-utils-ts` package lean and isomporphic, the debugging utilities are located in a separate package. This eliminates various error cases with bundlers (e.g. `webpack`, `esbuild`) when building for the browser.
2 changes: 1 addition & 1 deletion docs/capabilities/event-emitter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Event Emitter

The Event Emitter is a capability provided by AlgoKit Utils that allows for asynchronous event handling. It provides a flexible mechanism for emitting and listening to custom events, which can be particularly useful for debugging and extending functionality not available in the `algokit-utils-ts` package.
The Event Emitter is a capability provided by AlgoKit Utils that allows for asynchronous event handling of lifecycle events. It provides a flexible mechanism for emitting and listening to custom events, which can be particularly useful for debugging and extending functionality not available in the `algokit-utils-ts` package.

## `AsyncEventEmitter`

Expand Down
2 changes: 0 additions & 2 deletions src/types/async-event-emitter.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ describe('async-event-emitter', () => {
afterEach(logging.afterEach)

const mockRegisterNodeDebugHandlers = () => {
// TODO: Define types for the events
// TODO: Question - Would this be the package we'd use to surface the UI widget for downloading a simulate trace?
Config.events.on('event_a', (data: unknown) => {
logging.testLogger.info('event_a', data)
})
Expand Down

0 comments on commit df46204

Please sign in to comment.