diff --git a/src/client.ts b/src/client.ts index 92878f46..ba7a60fd 100644 --- a/src/client.ts +++ b/src/client.ts @@ -13,6 +13,9 @@ export const withEndpoint = (endpoint: string) => (client: Client) => { client.endpoint = endpoint; }; +/** + * @hidden + */ const defaultEndpoint = "https://jsonapi.sajari.net"; /** diff --git a/src/constructors.ts b/src/constructors.ts index 31af262e..1f9b77e2 100644 --- a/src/constructors.ts +++ b/src/constructors.ts @@ -82,6 +82,9 @@ export const newAggregates = (aggregateProto: any = {}): AggregateResponse => return agg; }, {}); +/** + * @hidden + */ export const tokenURL = "https://www.sajari.com/token/"; /** diff --git a/src/lib/request.ts b/src/lib/request.ts index 3939eff6..58dddf0e 100644 --- a/src/lib/request.ts +++ b/src/lib/request.ts @@ -1,4 +1,7 @@ -/** HTTP_STATUS_OK defines a constant for the http OK status. */ +/** + * HTTP_STATUS_OK defines a constant for the http OK status. + * @hidden + */ const HTTP_STATUS_OK: number = 200; export enum TransportError { diff --git a/src/pipeline.ts b/src/pipeline.ts index 5855bd91..72aef66b 100644 --- a/src/pipeline.ts +++ b/src/pipeline.ts @@ -5,6 +5,9 @@ import { Response } from "./results"; import { Session } from "./session"; import { Values } from "./types"; +/** + * @hidden + */ const UserAgent = "sdk-js-1.0.0"; /** @@ -23,7 +26,7 @@ export interface Pipeline { * Search runs a search query defined by a pipeline with the given values and * session configuration. The callback is executed with the query results and * any values that have been modified/created by the pipeline. If an error - * occurs this will be passed to the callback as a [[ResultError]]. + * occurs this will be passed to the callback as a [[RequestError]]. * * ```javascript * pipeline.search({ q: "" }, session, (error, results, values) => { diff --git a/src/session.ts b/src/session.ts index bc3020d8..4f0ca3ae 100644 --- a/src/session.ts +++ b/src/session.ts @@ -2,7 +2,7 @@ import { Values } from "./types"; -/** +/** * Tracking defines behaviour for handling search sessions and result interactions. */ export interface Tracking { @@ -42,7 +42,7 @@ export interface Session { reset(): void; } -/** TrackingType defines the possible result-interaction tracking types used by [[BaseSession]] */ +/** TrackingType defines the possible result-interaction tracking types used by [[DefaultSession]] */ export enum TrackingType { /** None disables tracking. */ None = "NONE", @@ -55,7 +55,7 @@ export enum TrackingType { /** * InteractiveSession creates a session based on text searches and is recommended * for use in search-as-you-type style interfaces. - * + * * It resets the session if the search query value: * * - Is `undefined`. @@ -147,7 +147,10 @@ export class DefaultSession implements Session { } } -/** newQueryID constructs a new ID for a query. */ +/** + * newQueryID constructs a new ID for a query. + * @hidden + */ const newQueryID = (): string => { let queryID = ""; for (let i = 0; i < 16; i++) {