MLE-24194 Initial TS support #1034
Merged
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
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 introduces initial TypeScript support for the MarkLogic Node.js client by adding type definitions and comprehensive type testing infrastructure. The changes enable TypeScript developers to benefit from type safety and IntelliSense when using the library.
Key Changes:
- Added TypeScript type definition file (
marklogic.d.ts) for theDatabaseClientConfiginterface - Created a comprehensive test suite for validating type definitions
- Integrated TypeScript type checking into the CI/CD pipeline
Reviewed Changes
Copilot reviewed 6 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| test-typescript/type-constraints.test.ts | Tests type constraints without module import by defining a mirror type to validate the interface structure |
| test-typescript/error-examples.test.ts | Demonstrates TypeScript's ability to catch type errors with commented invalid examples |
| test-typescript/basic-types.test.ts | Full integration test importing the marklogic module (currently excluded from tsconfig) |
| test-typescript/README.md | Documentation explaining the TypeScript testing approach and how to run/extend tests |
| package.json | Adds TypeScript dependencies, type definition reference, and test:types script |
| Jenkinsfile | Integrates TypeScript type checking into the CI pipeline |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Just doing the database config. Everything done by Copilot here, including the README that will either get updated or folded into the CONTRIBUTING at some point.
rjrudin
force-pushed
the
feature/24194-ts-for-db-config
branch
from
be997b9 to
6fceb4d
Compare
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.
Just doing the database config. Everything done by Copilot here, including the README that will either get updated or folded into the CONTRIBUTING at some point.