Class RecommendationResult

constructor

• new RecommendationResult(request): RecommendationResult

• Parameters

  • request: RecommendationRequest<Record<string, any>>

  Returns RecommendationResult

ErrorMessage

Optional RecommendationItems

Optional RecommendationRun

Request

Success

AppendError

• AppendError(errorMessage): void

• Appends the provided errorMessage param to the ErrorMessage property, with "Error: " prepended to the message and a newline character appended to the end. Also sets the Success property to false.

  Parameters

  • errorMessage: string

  Returns void

AppendWarning

• AppendWarning(warningMessage): void

• Appends the provided warningMessage param to the ErrorMessage property, with "Warning: " prepended to the message and a newline character appended to the end. The value of the Success property is not changed.

  Parameters

  • warningMessage: string

  Returns void

GetErrorMessages

• GetErrorMessages(): string[]

• Returns the ErrorMessage property as an array of strings. Useful in the event multiple errors or warnings were produced during the recommendation run.

  Returns string[]