Skip to content

Commit

Permalink
make additionalQueryPublic public
Browse files Browse the repository at this point in the history
  • Loading branch information
juliannzhou committed Aug 17, 2022
1 parent 729b686 commit 099973b
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 2 deletions.
15 changes: 15 additions & 0 deletions docs/search-core.basesearchconfig.additionalqueryparams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [BaseSearchConfig](./search-core.basesearchconfig.md) &gt; [additionalQueryParams](./search-core.basesearchconfig.additionalqueryparams.md)

## BaseSearchConfig.additionalQueryParams property

Additional query params added on to every request.

<b>Signature:</b>

```typescript
additionalQueryParams?: {
[key: string]: string | number | boolean;
};
```
1 change: 1 addition & 0 deletions docs/search-core.basesearchconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface BaseSearchConfig

| Property | Type | Description |
| --- | --- | --- |
| [additionalQueryParams?](./search-core.basesearchconfig.additionalqueryparams.md) | { \[key: string\]: string \| number \| boolean; } | <i>(Optional)</i> Additional query params added on to every request. |
| [endpoints?](./search-core.basesearchconfig.endpoints.md) | [Endpoints](./search-core.endpoints.md) | <i>(Optional)</i> Overrides for the URLs which are used when making requests to the Search API. |
| [experienceKey](./search-core.basesearchconfig.experiencekey.md) | string | The experience key of the search experience. |
| [experienceVersion?](./search-core.basesearchconfig.experienceversion.md) | 'STAGING' \| 'PRODUCTION' \| string \| number | <i>(Optional)</i> The version of the search experience configuration. |
Expand Down
1 change: 0 additions & 1 deletion etc/search-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,6 @@ export interface BaseFieldValueDirectAnswer<T = unknown> extends DirectAnswer<T>

// @public
export interface BaseSearchConfig {
// @alpha
additionalQueryParams?: {
[key: string]: string | number | boolean;
};
Expand Down
2 changes: 1 addition & 1 deletion src/models/core/SearchConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface BaseSearchConfig {
/**
* Additional query params added on to every request.
*
* @alpha
* @public
*/
additionalQueryParams?: {
[key: string]: string | number | boolean
Expand Down

0 comments on commit 099973b

Please sign in to comment.