refactor: convert ReadMe into a class
#958
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erunion
reviewed
Jan 31, 2024
Comment on lines
-58
to
-61
| // See comment at the auth definition below | ||
| let readmeAPIKey = ''; | ||
| let readmeProjectData: GetProjectResponse200 | undefined; | ||
| let readmeVersionData: ReadMeVersion[] | undefined; |
There was a problem hiding this comment.
moving everything into a class will also contain this data to the specific instance. as-is it'd be difficult/impossible to spin up different instances of the SDK against different projects (like a group of microservices) because this data would get clobbered between each
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
This updates the SDK to be a class. As part of this, the signature is slightly updated:
import { ReadMe } from 'readmeio'; - const readme = ReadMe(key); + const readme = new ReadMe(key); app.use(readme.express(() => {}));🧬 QA & Testing
Strongly suggest hiding whitespace before reviewing! Does this signature look good? Do tests still pass?