@nice-digital/search-client 2.0.1468-SRCH-666-Serialize-s → 2.0.1469-SRCH-666-Serialize-s

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types/models/Document.d.ts +2 -2
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nice-digital/search-client",
3
- "version": "2.0.1468-SRCH-666-Serialize-s",
3
+ "version": "2.0.1469-SRCH-666-Serialize-s",
4
4
  "description": "Search client for NICE digital services",
5
5
  "main": "./lib/index.js",
6
6
  "module": "./es/index.js",
package/types/models/Document.d.ts CHANGED
@@ -87,7 +87,7 @@ export declare type Document = ReadonlyDeep<{
87
87
  sourceUrl: string;
88
88
  staticAbstract: string | null;
89
89
  /**
90
- * @deprecated This method should no longer be used please use sectionLinks instead
90
+ * @deprecated This method should no longer be used please use subSections instead
91
91
  * An XML string
92
92
  *
93
93
  * @example
@@ -98,7 +98,7 @@ export declare type Document = ReadonlyDeep<{
98
98
  */
99
99
  subSectionLinks: string;
100
100
  /**
101
- * A JSON string
101
+ * A list of title/url objects representing sub sections within this result
102
102
  *
103
103
  * @example
104
104
  * [{ title: "Overview, url: "/guidance/cg187" }, ...]