Couchbase: Lots of missing things from v2.4.5 SDK #27457
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
added 10 commits
July 19, 2018 14:44
Documentation says key type is string or Buffer, not any. http://docs.couchbase.com/sdk-api/couchbase-node-client-2.4.5/Bucket.html
"code" was not optional, but it is definitely not included on all errors. I've added two more properties that I've seen in the couchbase source code.
The first page of the couchbase documentation contains the code that is now in couchbase-tests.ts (except that I've left out the underdocumented cluster.authenticate() call). For this, I've added the index management methods on the bucket manager interface as well as specific definitions for the events on the query response interfaces.
It's marked "uncommitted," but it's in the main page sample, so...
Needs some fixes to the Bucket query call, but that will be fixed here in a bit.
…rops Several important fixes.
The samples force us to recognize that the query callbacks are optional.
Even though this doesn't cover everything in the latest SDK, that's the version I based my changes on.
|
@fluggo Thank you for submitting this PR! 🔔 @maouida - please review this PR in the next few days. Be sure to explicitly select If no reviewer appears after a week, a DefinitelyTyped maintainer will review the PR instead. |
typescript-bot
added
the
Unmerged
|
After 5 days, no one has reviewed the PR 😞. A maintainer will be reviewing the PR in the next few days and will either merge it or request revisions. Thank you for your patience! |
ghost
merged commit
briandk
pushed a commit
to briandk/DefinitelyTyped
that referenced
this pull request
Jul 26, 2018
) * couchbase: Fix Bucket key parameter types Documentation says key type is string or Buffer, not any. http://docs.couchbase.com/sdk-api/couchbase-node-client-2.4.5/Bucket.html * couchbase: Add connect/error events to Bucket interface * couchbase: Add optional properties for errors "code" was not optional, but it is definitely not included on all errors. I've added two more properties that I've seen in the couchbase source code. * couchbase: Add enough features to get the front-page sample working The first page of the couchbase documentation contains the code that is now in couchbase-tests.ts (except that I've left out the underdocumented cluster.authenticate() call). For this, I've added the index management methods on the bucket manager interface as well as specific definitions for the events on the query response interfaces. * couchbase: Add authenticator API It's marked "uncommitted," but it's in the main page sample, so... * couchbase: Add the basic full-text search API Needs some fixes to the Bucket query call, but that will be fixed here in a bit. * couchbase: Split query API, add SearchQuery + FtsQueryResponse.Meta props Several important fixes. * couchbase: Add FTS facet and sorting capabilities * couchbase: Add more samples, make query callbacks optional The samples force us to recognize that the query callbacks are optional. * couchbase: Add version number and add me Even though this doesn't cover everything in the latest SDK, that's the version I based my changes on.
briandk
pushed a commit
to briandk/DefinitelyTyped
that referenced
this pull request
Aug 7, 2018
) * couchbase: Fix Bucket key parameter types Documentation says key type is string or Buffer, not any. http://docs.couchbase.com/sdk-api/couchbase-node-client-2.4.5/Bucket.html * couchbase: Add connect/error events to Bucket interface * couchbase: Add optional properties for errors "code" was not optional, but it is definitely not included on all errors. I've added two more properties that I've seen in the couchbase source code. * couchbase: Add enough features to get the front-page sample working The first page of the couchbase documentation contains the code that is now in couchbase-tests.ts (except that I've left out the underdocumented cluster.authenticate() call). For this, I've added the index management methods on the bucket manager interface as well as specific definitions for the events on the query response interfaces. * couchbase: Add authenticator API It's marked "uncommitted," but it's in the main page sample, so... * couchbase: Add the basic full-text search API Needs some fixes to the Bucket query call, but that will be fixed here in a bit. * couchbase: Split query API, add SearchQuery + FtsQueryResponse.Meta props Several important fixes. * couchbase: Add FTS facet and sorting capabilities * couchbase: Add more samples, make query callbacks optional The samples force us to recognize that the query callbacks are optional. * couchbase: Add version number and add me Even though this doesn't cover everything in the latest SDK, that's the version I based my changes on.
This pull request was closed.
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.
This patch set adds and fixes a variety of things, such as:
This patch set does not bring these definitions fully in-line with 2.4.5, but it gets them much closer.
Many definitions are written directly from the SDK's source code, because the SDK docs don't cover a lot of uses. Java docs have been used in many places where the Node SDK docs were missing.
npm test.)npm run lint package-name(ortscif notslint.jsonis present).If changing an existing definition:
tslint.jsoncontaining{ "extends": "dtslint/dt.json" }.