Skip to content

Commit 4b2896b

Browse files
committed
docs: add a test description linking back to reassure docs
1 parent 6151759 commit 4b2896b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

tests/perf-test/GooglePlacesUtils.perf-test.js

+10
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,16 @@ const bigObjectToFind = {
143143
'25doesnt-exist': 'long_name',
144144
};
145145

146+
/**
147+
* This function will be executed 20 times and the average time will be used on the comparison.
148+
* It will fail based on the CI configuration around Reassure:
149+
* @see /.github/workflows/reassurePerformanceTests.yml
150+
*
151+
* Max deviation on the duration is set to 20% at the time of writing.
152+
*
153+
* More on the measureFunction API:
154+
* @see https://callstack.github.io/reassure/docs/api#measurefunction-function
155+
*/
146156
test('getAddressComponents on a big dataset', async () => {
147157
await measureFunction(
148158
() => {

0 commit comments

Comments
 (0)