docs(typescript): API reference master#78
Merged
Conversation
|
Important Review skippedToo many files! This PR contains 275 files, which is 125 over the limit of 150. To get a review, narrow the scope: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (275)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
area:content
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the auto-generated API documentation for several TypeScript SDK packages, significantly expanding the descriptions and examples provided. It also modifies the navigation configuration in docs.json. Feedback highlights that the conversion of group labels to lowercase in docs.json may cause UI regressions and should be reverted. Additionally, the reviewer identified several spelling inconsistencies and a truncated sentence in the documentation, recommending that these be fixed in the source-level doc comments to ensure they persist through future regeneration cycles.
| "sdks/typescript/api/README", | ||
| { | ||
| "group": "Analytics", | ||
| "group": "analytics", |
There was a problem hiding this comment.
The group names have been changed from PascalCase/Title Case to lowercase. This is particularly problematic for brand names like "ResQ" (now "resq") and acronyms like "DSA" (now "dsa") or "HTTP" (now "http"). If these strings are used as labels in the documentation sidebar, this represents a regression in UI quality and readability. Please consider maintaining the original casing for display labels.
Suggested change
| "group": "analytics", | |
| "group": "Analytics", |
References
- In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.
| }, | ||
| { | ||
| "group": "Type Aliases", | ||
| "group": "type-aliases", |
There was a problem hiding this comment.
Category names like "Type Aliases" have been changed to kebab-case ("type-aliases"). This is likely an unintended side effect of a documentation generator update. These strings should ideally remain in Title Case for better presentation in the generated navigation menu.
Suggested change
| "group": "type-aliases", | |
| "group": "Type Aliases", |
References
- In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.
|
|
||
| #### Inherit Doc | ||
|
|
||
| a no-op.** `@upstash/ratelimit` distributes counters |
There was a problem hiding this comment.
The sentence here appears to be truncated or missing its beginning. Please apply the fix to the source-level documentation (e.g., TypeScript doc comments) instead of this generated file to ensure the fix persists across regeneration cycles.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g. XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| The presets are deliberately conservative — tighten them per-route | ||
| once you have real traffic data: | ||
|
|
||
| - `auth` — 5 requests / 15 min. Login, password reset, MFA enrol. |
There was a problem hiding this comment.
Inconsistent spelling detected ('enrol' vs 'enroll'). Please update the source-level documentation (e.g., TypeScript doc comments) to use US English for consistency with the rest of the project, rather than modifying this generated file.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g. XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| Defined in: [rate-limit.ts:58](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/rate-limiting/src/rate-limit.ts#L58) | ||
|
|
||
| Effect Schema for the structured result of an [IRateLimitStore](../interfaces/IRateLimitStore) | ||
| `check()`. Useful when serialising decisions to inter-service queues |
There was a problem hiding this comment.
Inconsistent spelling detected ('serialising' vs 'serializing'). Please update the source-level documentation to use US English to match the project's preferred spelling convention, rather than modifying this generated file.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g. XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| Concurrent calls with the same key may invoke `compute` more than | ||
| once — this method does **not** deduplicate in-flight loads. If | ||
| single-flight semantics matter, wrap `compute` in your own | ||
| promise-deduper or use a memoising decorator. |
There was a problem hiding this comment.
Inconsistent spelling detected ('memoising' vs 'memoizing'). Please apply this change to the source-level documentation instead of this generated file.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g. XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| `priority` defaults to `3` (mid-range) when omitted — encoded as a | ||
| decoding default rather than a TypeScript default so server-side | ||
| decoding produces the same shape regardless of how the JSON was | ||
| serialised. |
There was a problem hiding this comment.
Inconsistent spelling detected ('serialised' vs 'serialized'). Please apply this change to the source-level documentation instead of this generated file.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g. XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
|
|
||
| Normalizes Unicode to prevent homoglyph attacks | ||
| Converts to NFC form and replaces common lookalikes with ASCII | ||
| Canonicalise a string for safe equality checks against ASCII. |
There was a problem hiding this comment.
Inconsistent spelling detected ('Canonicalise' vs 'Canonicalize'). Please apply this change to the source-level documentation instead of this generated file.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g. XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
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
2 participants
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.
Auto-generated by
api-docsinresq-software/npmfor refmaster(run: 25919449431).
Regenerated files under
sdks/typescript/api/. Onesub-directory per
@resq-sw/*package. Review the difffor unintended exports and merge to publish.