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

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

# Function: describeRemediation()

> **describeRemediation**(`error`): [`Remediation`](../interfaces/Remediation.md) \| `undefined`

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

Recognizes an authentication or permission failure and describes the fix.

## Parameters

### error

`unknown`

Thrown error or message

## Returns

[`Remediation`](../interfaces/Remediation.md) \| `undefined`

The remediation, or undefined when the failure is not recognized or
  the message already explains the fix

## Example

```typescript
import {describeRemediation} from '@salesforce/b2c-tooling-sdk/errors';

const remediation = describeRemediation(error);
if (remediation) console.error(`${remediation.hint} See ${remediation.doc.url}`);
```
