Skip to content

Commit

Permalink
docs(atomic): add link to headless search engine (#3470)
Browse files Browse the repository at this point in the history
doc: added link

Also added missing period.
  • Loading branch information
srosenberg-coveo authored Dec 12, 2023
1 parent 8277b29 commit fc563a8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions packages/atomic/src/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2191,7 +2191,7 @@ export namespace Components {
*/
"fieldsToInclude": string[] | string;
/**
* Returns the unique, organization-specific endpoint(s)
* Returns the unique, organization-specific endpoint(s).
* @param organizationId
* @param env
*/
Expand All @@ -2209,7 +2209,7 @@ export namespace Components {
*/
"initialize": (options: InitializationOptions) => Promise<void>;
/**
* Initializes the connection with an already preconfigured headless search engine, as opposed to the `initialize` method which will internally create a new search engine instance. This bypasses the properties set on the component, such as analytics, searchHub, pipeline, language, timezone & logLevel.
* Initializes the connection with an already preconfigured [headless search engine](https://docs.coveo.com/en/headless/latest/reference/search/), as opposed to the `initialize` method, which will internally create a new search engine instance. This bypasses the properties set on the component, such as analytics, searchHub, pipeline, language, timezone & logLevel.
*/
"initializeWithSearchEngine": (engine: SearchEngine) => Promise<void>;
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ export class AtomicSearchInterface
}

/**
* Initializes the connection with an already preconfigured headless search engine, as opposed to the `initialize` method which will internally create a new search engine instance.
* Initializes the connection with an already preconfigured [headless search engine](https://docs.coveo.com/en/headless/latest/reference/search/), as opposed to the `initialize` method, which will internally create a new search engine instance.
* This bypasses the properties set on the component, such as analytics, searchHub, pipeline, language, timezone & logLevel.
*/
@Method() public initializeWithSearchEngine(engine: SearchEngine) {
Expand Down Expand Up @@ -367,7 +367,7 @@ export class AtomicSearchInterface
}

/**
* Returns the unique, organization-specific endpoint(s)
* Returns the unique, organization-specific endpoint(s).
* @param {string} organizationId
* @param {'prod'|'hipaa'|'staging'|'dev'} [env=Prod]
*/
Expand Down

0 comments on commit fc563a8

Please sign in to comment.