-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Common Recorder] Updated README #5288
Conversation
sdk/test-utils/recorder/README.md
Outdated
`@azure/keyvault/keyvault-keys` repository). It must be used inside of Mocha's | ||
tests, since it uses [nise](https://www.npmjs.com/package/nise) under the hood. | ||
It also returns an object with a method `stop()`, which will allow you to control when | ||
you want the recorder to stop re-routing your http requests. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add link for more detailed description?
https://github.com/Azure/azure-sdk-for-js/blame/master/sdk/test-utils/recorder/GUIDELINES.md#L79
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
getUniqueName and newDate are not part of src/index.ts though! Should we make an issue?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They are part of the Recorder
interface that is being exported in the src/index.ts file.
getUniqueName: (prefix: string, label?: string) => string; |
record(this)
is invoked in the beforeEach section.
record(this)
returns the Recorder interface which has a bunch of functions attached to it.
stop
, skip
, getUniqueName
, newDate
export function record(testContext: Mocha.Context): Recorder { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job, @sadasant !!! 🤩
I could only review half of the document, I'll take some time to review it completely. 🥱
781a171
to
abea651
Compare
abea651
to
5175145
Compare
4bb817e
to
12b6598
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉
This is just a proposal! Let's review it and make it better together <3
Fixes #4961