Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(): add executed query length to search response #1733

Merged
merged 6 commits into from
Nov 22, 2024

Conversation

jordantsanz
Copy link
Contributor

@jordantsanz jordantsanz commented Nov 13, 2024

  1. Description: Adds an optional executedQueryLength: Kilobyte (number) to the IHubSearchResponse object to allow for calculating the size of a query.

  2. Instructions for testing:

  3. Closes Issues: #11590

  4. Updated meaningful TSDoc to methods including Parameters and Returns, see Documentation Guide

  5. used semantic commit messages

  6. PR title follows semantic commit format (CRITICAL if the title is not in a semantic format, the release automation will not run!)

  7. updated peerDependencies as needed. CRITICAL our automated release system can not be counted on to update peerDependencies so we must do it manually in our PRs when needed. See the updating peerDependencies section of the release instructions for more details.

Copy link
Member

@mjuniper mjuniper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Only question is why represent it in kilobytes instead of bytes?

@jordantsanz
Copy link
Contributor Author

jordantsanz commented Nov 14, 2024

LGTM. Only question is why represent it in kilobytes instead of bytes?

Fair question @mjuniper. I put it in kilobytes as the size limit for a query string for AGO's api is 10kb -- so I thought it might be easier to just keep it in kb to track.

Happy to change this to bytes though if you think it'd be clearer for devs/easier to repurpose in the future/less confusing in general, though.

Copy link

There hasn't been any activity on this pull request in the past 3 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days. If you want this PR to never become stale, please apply the "Draft" label.

@github-actions github-actions bot added the Stale Stale issue - update or it will be closed label Nov 22, 2024
@jordantsanz jordantsanz merged commit 1388046 into master Nov 22, 2024
5 checks passed
@jordantsanz jordantsanz deleted the f/11590-catalog-limits branch November 22, 2024 15:02
esri-dcdev-2 pushed a commit that referenced this pull request Nov 22, 2024
# @esri/hub-common [15.10.0](https://github.com/Esri/hub.js/compare/@esri/hub-common@15.9.0...@esri/hub-common@15.10.0) (2024-11-22)

### Features

* add executed query length to search response ([#1733](#1733)) ([1388046](1388046))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Stale Stale issue - update or it will be closed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants