[SDK] SDK documentation - JavaScript#138
Open
CoolatMax wants to merge 1 commit into
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 introduces comprehensive documentation for the JavaScript/TypeScript SDK. As part of the Phase 2 enhancements, this documentation provides developers with a clear path from installation to advanced error handling, ensuring the SDK is accessible for both Node.js and Browser environments.
Related Issues
Closes #120
Parent Epic #116
Changes Made
Created
docs/sdk-js.md: Centralized guide for the JS/TS SDK.Installation Guide: Detailed the
npminstallation process and package naming.Authentication: Documented the$KONG\_ADMIN\_URL$ ).
KongAdminClientconstructor logic and environment variable usage (API Reference: Mapped and documented core methods from
client.tsincluding Consumer and Key-Auth management.Error Handling: Documented custom error classes (
KongApiError,ConsumerNotFoundError) mapped fromerrors.ts.TypeScript Support: Added examples for using exported interfaces and types for better DX.
Image