---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [errors](../index.md) / withRemediationHint

# Function: withRemediationHint()

> **withRemediationHint**(`message`): `string`

Defined in: [packages/b2c-tooling-sdk/src/errors/remediation.ts:178](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/errors/remediation.ts#L178)

Appends a remediation hint and a documentation link, for people reading terminal output.

## Parameters

### message

`string`

Original error message

## Returns

`string`

The message with a hint appended, or unchanged when nothing is recognized
