@rapharacing/lambda-utils/README.md

Lambda Utils

# Lambda Utils

## Installation

`yarn add @rapharacing/lambda-utils`

## How to use

```js
import * as utils from "@rapharacing/lambda-utils";

import {
	errorResponse,
	cognitoErrorResponse,
	requestConfig,
	formatAuthorizationToken,
} from "@rapharacing/lambda-utils";
```

## License

Design tokens are freely distributable under the terms of the [MIT license](https://github.com/rapharacing/design-tokens/blob/develop/Licence).

[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat

[license-url]: https://github.com/moment/moment/blob/develop/LICENSE

# API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [errorResponse](#errorresponse)
    -   [Parameters](#parameters)
-   [cognitoErrorResponse](#cognitoerrorresponse)
    -   [Parameters](#parameters-1)
-   [requestConfig](#requestconfig)
    -   [Parameters](#parameters-2)
-   [formatAuthorizationToken](#formatauthorizationtoken)
    -   [Parameters](#parameters-3)

## errorResponse

Returns a Error Object

### Parameters

-   `error` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Error response from AWS or CC
-   `customKey` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Custom error key to overwrite stack errors
-   `customMessage` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Custom error message to overwrite stack errors

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Error

## cognitoErrorResponse

Returns a Error key

### Parameters

-   `error` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Error response from AWS or CC
-   `customMessage` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Custom error message to overwrite stack errors

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Error key

## requestConfig

Returns a configuration object for axios

### Parameters

-   `data` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Data to be sent as the request body
    -   `data.url`  
    -   `data.method`  
    -   `data.token`  
    -   `data.data`  

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Configuration object

## formatAuthorizationToken

Format Authorization Token

### Parameters

-   `token` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Token

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Token