Skip to content

Commit 9cdf9a7

Browse files
update readme
1 parent 3eb7516 commit 9cdf9a7

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,13 @@ This package does provide one gathering function: `analyzeEmberObject`. The fun
5959
const { analyzeEmberObject } = require('ember-codemods-telemetry-helpers');
6060
```
6161

62+
## Caveats
63+
If the gather function references functions defined outside of the the gather function body, all of those functions must be exported as well. It is strongly suggested that the gather function be self contained, and if functions must be used (code maintainability/readability), that they be defined within the function. If this is not possible, the `gatherTelemetryForUrl` has been enhanced to accept all functions that must go along with the gather function:
64+
65+
```javascript
66+
gatherTelemetryForUrl(appLocation, gatherFunction, suppportFn1, suppportFn2, ..., puppeteerArgs);
67+
```
68+
6269
## Contributing
6370

6471
### Installation

0 commit comments

Comments
 (0)