Fix the examples #205
Merged
Fix the examples #205
Conversation
This file contains hidden or 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
Since the migration to TypeScript, examples had to be adjusted. The SDK now uses named exports. Also the SDK needs to be built before examples can be run. This is now displayed on top of the example instructions. Since the SDK now used package exports, the examples can now import the package using its name instead of relative imports. Some ESLint warnings have been disabled for the examples. Incorrect paths to example fixtures have been fixed. The examples are now type-checked using JSDoc based type annotations. Closes #204
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #205 +/- ##
=======================================
Coverage 68.75% 68.75%
=======================================
Files 6 6
Lines 624 624
Branches 123 123
=======================================
Hits 429 429
Misses 195 195
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
mifi
approved these changes
Dec 7, 2024
mifi
reviewed
Dec 7, 2024
Acconut
approved these changes
Dec 9, 2024
Contributor
Acconut
left a comment
Acconut
left a comment
There was a problem hiding this comment.
Thank you for this quick PR! It looks good to me and I just have a minor question.
| authSecret: /** @type {string} */ (process.env.TRANSLOADIT_SECRET), | ||
| // authKey: /** @type {string} */ (process.env.API2_SYSTEMTEST_AUTH_KEY), | ||
| // authSecret: /** @type {string} */ (process.env.API2_SYSTEMTEST_SECRET_KEY), | ||
| // endpoint: /** @type {string} */ ('https://api2-vbox.transloadit.com'), |
Contributor
There was a problem hiding this comment.
The three values that are commented out are the result from internal from other repositories and don't serve a purpose for our users. Should we just remove them here?
Member
Author
There was a problem hiding this comment.
I kept it as-is, but I agree this should probably be removed.
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.
Since the migration to TypeScript, examples had to be adjusted. The SDK now uses named exports. Also the SDK needs to be built before examples can be run. This is now displayed on top of the example instructions.
Since the SDK now used package exports, the examples can now import the package using its name instead of relative imports.
Some ESLint warnings have been disabled for the examples.
Incorrect paths to example fixtures have been fixed.
The examples are now type-checked using JSDoc based type annotations.
Closes #204