feat: add jsdoc comments to v6 public interface types #690
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
🦋 Changeset detectedLatest commit: 87cea48 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
kand
approved these changes
Oct 2, 2025
gregjopa
reviewed
Oct 6, 2025
|
|
||
| export interface PayPalV6Namespace { | ||
| /** | ||
| * Creates an SDK instance with the specified components and configuration. |
There was a problem hiding this comment.
Suggested change
| * Creates an SDK instance with the specified components and configuration. | |
| * Creates a SDK instance which is the first step in a SDK integration. This instance serves as the base layer for all SDK components. |
gregjopa
reviewed
Oct 6, 2025
| * Creates an SDK instance with the specified components and configuration. | ||
| * | ||
| * This is an asynchronous method that initializes the PayPal SDK with the provided | ||
| * client token and components. The SDK is designed to be lightweight and modular, |
There was a problem hiding this comment.
I think we should remove this part about the SDK design. It feels like marketing material.
Suggested change
| * client token and components. The SDK is designed to be lightweight and modular, | |
| * client token and components. |
gregjopa
reviewed
Oct 6, 2025
| * allowing you to load only the functionality you need. | ||
| * | ||
| * @param {CreateInstanceOptions} createInstanceOptions - Configuration options for creating the SDK instance | ||
| * @returns {Promise<SdkInstance<T>>} - A promise that resolves to an SDK instance with methods based on the specified components |
There was a problem hiding this comment.
I don't think there's any context about what T is here for the generic to make sense. I wonder if we can replace with
Suggested change
| * @returns {Promise<SdkInstance<T>>} - A promise that resolves to an SDK instance with methods based on the specified components | |
| * @returns {Promise<SdkInstance<Components[]>>} - A promise that resolves to an SDK instance with methods based on the specified components |
gregjopa
approved these changes
Oct 6, 2025
There was a problem hiding this comment.
Awesome work @nbierdeman! 💯
I left a minor comment about the createInstance description. After that's addressed, I'm happy to see this get merged.
nbierdeman
force-pushed
the
feature/DTPPCPSDK-3708-add-jsdoc-comments-to-types
branch
from
5596195 to
b9f0713
Compare
nbierdeman
deleted the
feature/DTPPCPSDK-3708-add-jsdoc-comments-to-types
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR adds JSDoc comments to v6 public interface types.