MLE-24194 Adding TS for releaseClient and checkConnection #1035
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
Also added a test-project for manual testing.
rjrudin
requested review from
BillFarber,
anu3990 and
stevebio
as code owners
|
Copyright Validation Results ⏭️ Skipped (Excluded) Files
✅ Valid Files
✅ All files have valid copyright headers! |
There was a problem hiding this comment.
Pull Request Overview
This PR adds TypeScript support for the releaseClient() and checkConnection() methods, and includes a manual testing project to validate the TypeScript definitions.
Key Changes:
- Added TypeScript type definitions for connection management methods (
checkConnection()andreleaseClient()) - Created a standalone TypeScript test project for manual validation and demonstration
- Added type-checking tests to verify correctness of the new TypeScript definitions
Reviewed Changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| typescript-test-project/tsconfig.json | TypeScript compiler configuration for the manual test project with strict type checking enabled |
| typescript-test-project/test.ts | Example TypeScript code demonstrating usage of connection methods with autocomplete and type safety |
| typescript-test-project/setup.sh | Installation script for setting up the test project dependencies |
| typescript-test-project/package.json | NPM package configuration linking to parent marklogic package for local testing |
| typescript-test-project/README.md | Documentation explaining the purpose and usage of the test project |
| typescript-test-project/.gitignore | Git ignore rules for node modules and build artifacts |
| test-typescript/connection-methods.test.ts | Type-checking tests validating the TypeScript definitions for connection methods |
| test-typescript/README.md | Removed outdated documentation sections about test structure |
| CONTRIBUTING.md | Added documentation reference for TypeScript testing |
| .copyrightconfig | Excluded shell scripts from copyright header requirements |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Also added a test-project for manual testing.