Fix/documentation supplement in address search

[jedi-of-the-sea]

Summary

The configuration examples in AddressSearch were not sufficient in case of the bkg and mpapi search methods. To prevent a linting error, it is necessary to typecast the queryParameters to BKGParameters or MpApiParameters.

Instructions for local reproduction and review

Pull Request Checklist (for Reviewee)

• Changelogs are maintained - not relevant
• Functionality has been tested in Firefox, Chrome, Safari - not relevant
• Functionality has been tested on a smartphone - not relevant
• Functionality has been tested with 200% screen zoom - not relevant
• Screenreader functionality has been manually tested with NVDA - not relevant

UI has been tested in the following tools regarding accessibility (only regarding functionality affected in this PR) - not relevant

• Chrome Lighthouse - not relevant
• Firefox Accessibility - not relevant

[warm-coolguy]

I would like to reject this pull request since it changes documentation facing users that currently do not have access to our type files (they're not part of the published packages), and we know most of them use .js anyway. Furthermore, examples explicitly refer to javascript (as seen on code fences: "```js") and this wouldn't be valid syntax there.

@jedi-of-the-sea Should you agree, please close this pull request.

[jedi-of-the-sea]

I would like to reject this pull request since it changes documentation facing users that currently do not have access to our type files (they're not part of the published packages), and we know most of them use .js anyway. Furthermore, examples explicitly refer to javascript (as seen on code fences: "```js") and this wouldn't be valid syntax there.

@jedi-of-the-sea Should you agree, please close this pull request.

@warm-coolguy I partly wanted to document this for myself because in a few month I might have forgotten about this problem and will be confused again 😅 But I agree that the example configurations should not be altered if they are for javascript. Maybe a hint like "Please note that you need to specify the type queryParameters as BKGParameters / MpApiParameters when using typescript" after the corresponding documentation of type=bkg / type=mpapi? Would that be a good compromise?

[warm-coolguy]

@jedi-of-the-sea Since our users can't use our typescript types, that's still somewhat confusing to them; I'd expect to have a usable .d.ts file on reading that, and there'd be none to find.

Alternative suggestion: We extend the QueryParameters interface to

/**
 * Additional queryParameters for the GET-Request;
 * for the specific parameters for each request,
 * please refer to the types in the plugin
 */
export interface QueryParameters {
  /** sets the maximum number of features to retrieve */
  maxFeatures?: number
  /** depending on backend service, anything may belong to the query */
  [key: string]: unknown
}

That's a little unspecific, but saves us various typecasts, and is ultimately true.

@dopenguin Requesting approval for change.

[dopenguin]

I'd go along with

I would like to reject this pull request since it changes documentation facing users that currently do not have access to our type files (they're not part of the published packages), and we know most of them use .js anyway. Furthermore, examples explicitly refer to javascript (as seen on code fences: "```js") and this wouldn't be valid syntax there.

@jedi-of-the-sea Should you agree, please close this pull request.

However, it may become interesting again if we deliver d.ts-files along with out package, as mentioned in #221 (comment). But that would probably need a merge of e.g. #108 and an upgrade to vue@3 - so nothing relevant for now.