Docs and typings fixes for skipUndefined, koa-ts example, and returning options#2806
Open
kartikdp wants to merge 1 commit intoVincit:mainfrom
Open
Docs and typings fixes for skipUndefined, koa-ts example, and returning options#2806kartikdp wants to merge 1 commit intoVincit:mainfrom
kartikdp wants to merge 1 commit intoVincit:mainfrom
Conversation
777fc87 to
58964bd
Compare
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
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.
Summary
This PR addresses three open contribution targets with small, low-risk changes:
#2149docs: markskipUndefined()as deprecated in the query-builder docs.#2361example: fixexamples/koa-ts/api.tsTypeScript errors caused byctx.request.bodybeing typed asunknownin newer typings.#2309typings: allowreturning(..., options)in Objection typings (for exampleincludeTriggerModifications).Changes
doc/api/query-builder/other-methods.mdkoa-tsexample to pass typed request bodies to query methods through a small helper:examples/koa-ts/api.tsReturningMethodtypings with optional options arg and added typings coverage example:typings/objection/index.d.tstests/ts/examples.tsHow tested
npx tsc -p examples/koa-ts/tsconfig.json --skipLibChecknpm run test:typingsNotes
If maintainers prefer, I can split this into separate PRs per issue.
If it helps with project maintenance bandwidth, I can also help with ongoing docs/typings/example fixes and issue triage.