Skip to content

Issue #3303410: Deprecate the query feature

Coby Sher requested to merge issue/drupal_state-3303410:drupal_state-3303410/3303410-remove-query-feature into 1.0.x

This MR removes the query feature on getObject and getObjectByPath. This will be a breaking change in a future, but for now if a query is used it will console.warn a message in the console that the query option is deprecated and DrupalState will continue the request without the query. In a future release, this will be removed and the query option will be removed entirely.

Various updates in this MR include:

  • Update TSDoc comments for getObject and getObjectByPath
  • Add a console.warn when query option is used
  • Update docs to show the query option is deprecated
  • Remove dependencies related to query
  • Update tests
  • changed index param name to hrefIndex in assemble endpoint and added type predicate for GenericIndex
    • Likely still room for improvement here, also I'm unsure of the rename but index felt wrong too.
Edited by Coby Sher

Merge request reports