docs(types): add typing utilities for v0.14.0 and expand TSDoc examples#535
Merged
docs(types): add typing utilities for v0.14.0 and expand TSDoc examples#535
Conversation
- Add `ReadonlyRecord<K,V>`, `DeepPartial<T>`, `DeepReadonly<T>`, `Mutable<T>`, `DeepRequired<T>`, `ValueOf<T>`, and `NonEmptyArray<T>` type aliases in `lib/src/helpers/types.ts` (@SInCE 0.14.0, @group Helpers) - Add compile-time and runtime tests in `lib/test/src/common/helpers/types.test.ts` - Expand TSDoc on `ArrGroupByCallbackFn` with full @param/@returns and three @example blocks (parity grouping, object-by-property, index bucketing) - Expand TSDoc on `RequestIdleCallback` and `CancelIdleCallback` with @group tags and @example blocks showing schedule/cancel patterns - Add @since/@group tags and @example blocks to `TypeFuncNames` and `ProxyFunctionDef` in `lib/src/funcs/types.ts` - Add @example blocks to all seven new type aliases in `lib/src/helpers/types.ts` - Update `docs/usage-guide.md` with a Type Utility Aliases section and examples
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #535 +/- ##
=======================================
Coverage 99.44% 99.45%
=======================================
Files 141 142 +1
Lines 4181 4187 +6
Branches 903 922 +19
=======================================
+ Hits 4158 4164 +6
Misses 23 23
🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds new TypeScript type-utility aliases to @nevware21/ts-utils (v0.14.0) and expands TypeDoc/TSDoc examples across the library and docs.
Changes:
- Introduces helper type aliases (e.g.,
DeepPartial,DeepReadonly,DeepRequired,ValueOf,NonEmptyArray) and re-exports them from the main index. - Adds a new common test file intended to validate the new aliases at compile time.
- Expands TSDoc examples/groups for
arrGroupBy, idle-callback types, and function-proxy typing helpers; updates usage docs/backlog accordingly.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| lib/src/helpers/types.ts | Adds new exported type aliases with TSDoc, examples, and grouping. |
| lib/src/index.ts | Re-exports the new helper type aliases from the package entrypoint. |
| lib/test/src/common/helpers/types.test.ts | Adds compile-time alias validation tests. |
| lib/src/timer/idle.ts | Expands TSDoc for idle callback type aliases with groups and examples. |
| lib/src/funcs/types.ts | Adds @since/@group and examples for existing exported type utilities. |
| lib/src/array/groupBy.ts | Expands TSDoc for ArrGroupByCallbackFn (params/returns/examples). |
| docs/usage-guide.md | Adds “Type Utility Aliases” section with example usage. |
| docs/feature-backlog.md | Updates backlog metadata/structure (target version and section renumbering). |
…t type Agent-Logs-Url: https://github.com/nevware21/ts-utils/sessions/761da501-049f-43bf-a6fb-2e22dbbd7d1e Co-authored-by: nev21 <82737406+nev21@users.noreply.github.com>
Contributor
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
nevware21-bot
approved these changes
Mar 30, 2026
Contributor
nevware21-bot
left a comment
nevware21-bot
left a comment
There was a problem hiding this comment.
Approved by nevware21-bot
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.
DeepRequired<T>inlib/src/helpers/types.tsto applyNonNullable<>when recursingDeepPartialtest inlib/test/src/common/helpers/types.test.ts: changeReadonlyArray<string | undefined>→ReadonlyArray<string>💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.