core: change direction to orderBy for history, use enum #420
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
AndyTWF
requested review from
a team,
owenpearson and
JoaoDiasAbly
and removed request for
a team
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
AndyTWF
requested review from
vladvelici
and removed request for
JoaoDiasAbly
github-actions
bot
temporarily deployed
to
staging/pull/420/typedoc
Coverage Report
File Coverage
|
||||||||||||||||||||||||||||||||||||||||||||||||||
AndyTWF
force-pushed
the
chat-history-direction
branch
from
a41008e
to
34ff9c6
Compare
github-actions
bot
temporarily deployed
to
staging/pull/420/typedoc
As already done for Swift/Kotlin, this change renames the direction parameter of the history parameters to orderBy. Instead of using string values, we now use an enum. The ChatApi now does a mapping to the backend format (which itself will change at a later date).
AndyTWF
force-pushed
the
chat-history-direction
branch
from
34ff9c6
to
8e6508b
Compare
vladvelici
reviewed
Dec 3, 2024
| /** | ||
| * The order in which results should be returned when performing a paginated query (e.g. message history). | ||
| */ | ||
| export enum ResultOrder { |
There was a problem hiding this comment.
OrderBy?
Nitpick, not strong opinion.
Just thinking it might be easier to remember to type messages.get({orderBy: OrderBy.NewestFirst}) rather than messages.get({orderBy: ResultOrder.NewestFirst}).
Another nitpick: should we define this in chat-api.ts instead?
There was a problem hiding this comment.
Worth bringing up with ecosystems (that's where ResultOrder originates from) - once the DR is agreed and we definitely do this, we can deffo consider this change :)
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.
Description
As already done for Swift/Kotlin, this change renames the direction parameter of the history parameters to orderBy. Instead of using string values, we now use an enum.
The ChatApi now does a mapping to the backend format (which itself will change at a later date).
Checklist
Testing Instructions (Optional)
N/A