Improve markdown links in TS comments #754
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
rattrayalex-stripe
added a commit
that referenced
this pull request
Jan 10, 2020
* Drop support for Node 6 * TypeScript definitions [beta] (#736) * First pass * wip * More changes * Split resources by file * Move to api version folder * Remove tsconfig, add prettierignore * Properly generate nested and no-method resources * Document new TypeScript usage in README * Add a basic test for typescript correctness * Better formatting for export of Stripe * Break out subtypes * Separate out Address * Pull empty strings out of enums * Use all named subresources from openapi * Rough draft of using shared subresources * Revert "Rough draft of using shared subresources" This reverts commit eb9a4d8. * Fix some bugs I think * Okay actually go back to normal * Actually use all shared subresources from openapi * Revert "Actually use all shared subresources from openapi" This reverts commit 52136ae. * Add webhooks.d.ts * Add and test ApiListPromise for async iteration of lists * Add better types for ApiList and HeaderOptions * Rename HeaderOptions to RequestOptions * Add docs and tests for expanding objects * Add in reference to webhooks.d.ts * Update snapshots to reflect reordering * Add multiple dispatch for optional params * Add TS tests for multiple dispatch, config, etc * Move types for setAppInfo * Add errors * Fix some formatting * Remove (Customer) Source and ExternalAccount * Move metadata back up, add deleted?: void, add eg DeletedCustomer to the union for expandable deletable objects * Reorder nested methods, rename nested & delete param types, move nested model & param types into their own files * Remove docstrings from param types since they exist on method definitions * Reorder required params to be first * Minor method reorder * Describe why you have to explicitly reference the types * Move from vYYYY-MM-DD to YYYY-MM-DD, upgrade api version to 2019-12-03 * Update future version * Fix param type name and mention esModuleInterop in docs * Add docstring and test for ApiList * Add docstrings for errors * Fix accidentally optional fields * Add missing values to RawErrorType * Fix many non-optional fields * Remove whitespace typo * Add signature for retrieving a specific account * Add types for OAuth * Openapi updates * Rename Webhooks in git * Use export default instead of export = so that users dont need to do esModuleInterop * Add a default export to the runtime * Also export Stripe as a named export, and as a static property on itself * Collapse types for setHost * Require the user to specify the latest API version, use types by default. * Fix a type error * Reorganize test, use strictNullChecks etc * Fix readme * Unexport error classes to avoid instanceof confusion * Clarify how to use old api versions with TS * Fix typo params -> param * Updates from openapi * Mark the args to several setters as required * More accurate handling of deleted resources and required/optional fields * Erroneous handling of deleted * Revert "Erroneous handling of deleted" This reverts commit ad64e33. * Add comment about deprecated total_count. * Add shared types for Addresses and Metadata, and update openapi * Use null intead of empty string * Fix invoice upcoming lines * Update openapi * More empty-string to null translation * Stop polluting the global namespace by scoping everything under module stripe * Run eslint & prettier on TS files * Continue to have poor types for HttpAgent, but with more claity as to why * Clean up explicit any lint warnings * Remove constants intended for internal use only * Extract CustomerSource to a standalone type * Remove unnecessary export * Better types for account debit sources * Use shared RangeQueryParam and PaginationParam * Add expand param to SubscriptionDeleteParams * Bring business_type back * Add docstrings to config options * Add mandatory `typescript: true` config prop * Use await in TS readme * Wrap await in async function * Many readme updates * Remove docs on non-public fields/params (we should revert this if it comes up a lot) * Clarify async/await a bit * TypeScriptify docstrings for Webhooks * Add @types/node as a dependency, use it for typing Buffer and http.Agent * Remove a TODO Co-authored-by: jlomas-stripe <jlomas-stripe@users.noreply.github.com> * Small typo fixes (#743) * Correct "eg;" to "e.g.," * Fix typo * Remove deprecated resources and methods (#744) * Remove stripe.usageRecords and stripe.usageRecordSummaries, add stripe.subscriptionItems.listUsageRecordSummaries * Update openapi * Remove Recipients * Remove BitcoinReceivers * Remove ThreeDSecure * Fix SubscriptionSchedules.Plan.plan (#748) It was incorrectly pointing back to SubscriptionSchedules.Plan instead of Stripe.Plan * Openapi updates * Use Stripe. prefix for all top-level resources (#751) * Deprecate many library api's, unify others (#752) * Deprecate snake_case options like stripe_account with warning messages * Remove deprecated Error base export, extend method, and populate method * Privatize several constants * Add protocol to config object for local proxies etc * Add `appInfo` config option * Mark all setter methods as deprecated, emit warnings. * Mark methods prefixed with an underscore as private * Mark a few getter methods which are not prefixed with underscores as private * Rename the request option stripeVersion to apiVersion to be consistent with the config option and our overall terminology * Throw an error if a deprecated and non-deprecated version of the same request option is passed * Accept an array of strings or buffers as the header argument for webhooks.constructEvent (#753) * Stop importing errors as a single Error object, which shadowed the real Error object * Accept an array of strings (or buffers) as the header in webhooks * Actually just throw an error if an array is actually passed * Improve markdown links in TS comments (#754) Co-authored-by: jlomas-stripe <jlomas-stripe@users.noreply.github.com> Co-authored-by: Petja Touru <hello@petja.me>
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.
r? @richardm-stripe
cc @stripe/api-libraries
Makes many markdown links be full URL's instead of relative paths or hashes, so that cmd+click in IDE's works.