--- title: "@dynatrace-sdk/shared-client-utils" description: --- # @dynatrace-sdk/shared-client-utils import NpmLogo from '@site/static/img/npm-logo.png';

v1.0.1

```bash npm install @dynatrace-sdk/shared-client-utils ``` ## Functions ### apiGatewayErrorsHandler

apiGatewayErrorsHandler(response): Promise<void>

Handles errors from API Gateway responses. Throws an ApiGatewayError if the response source is 'API Gateway'.

#### Parameters | Name | Type | Description | | --- | --- | --- | |response^*required|HttpClientResponse|The HTTP response to check for API Gateway errors. |

### getErrorMessage

getErrorMessage(errorBody,defaultMessage): [string](https://developer.mozilla.org/en-US/docs/Glossary/String)

Returns a user-friendly error message from an error body object.

#### Parameters | Name | Type | Description | | --- | --- | --- | |errorBody^*required|unknown|The error object or response body to extract the message from. | |defaultMessage^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The default message to use if no error message is found. | #### Returns | Return type | Description | |---|---| |[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | The extracted or default error message, possibly including details.|

### mimeTypeToEncoding

mimeTypeToEncoding(mimeType,defaultEncoding?): Encoding

Maps a MIME type string to an Encoding.

#### Parameters | Name | Type | Description | | --- | --- | --- | |mimeType^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The MIME type to convert (e.g., 'application/json'). | |defaultEncoding|Encoding|The encoding to return if the MIME type isn't recognized. | #### Returns | Return type | Description | |---|---| |Encoding | The corresponding Encoding enum value, or the defaultEncoding if not recognized.|

### toQueryString

toQueryString(rawQuery?,flags?): [string](https://developer.mozilla.org/en-US/docs/Glossary/String)

Converts an object of query parameters into a URL query string.

#### Parameters | Name | Type | Description | | --- | --- | --- | |rawQuery|QueryParamsType|The object containing query parameters. | |flags|[ParametersFlags](#parametersflags)|Flags to control parameter formatting (e.g., explode arrays). | #### Returns | Description | |---| |The resulting query string.|

### transformFromFormData

transformFromFormData(formData,fields): T

Converts form data and field definitions into a typed object, applying transformations for JSON fields.

#### Parameters | Name | Type | Description | | --- | --- | --- | |formData^*required|FormDataResponseBody|The form data to convert. | |fields^*required|Record<[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | FormDataResponseFieldDefinition>|The field definitions for the form data. | #### Returns | Return type | Description | |---|---| |T | The resulting typed object.|

### transformRequest

transformRequest(object,rules): T

Transforms an object by applying transformation rules before sending it in a request.

#### Parameters | Name | Type | Description | | --- | --- | --- | |object^*required|T|The object to transform. | |rules^*required|TransformRulesParam|The transformation rules to apply. | #### Returns | Return type | Description | |---|---| |T | The transformed object.|

### transformResponse

transformResponse(object,rules): T

Transforms an object by applying transformation rules after receiving it in a response.

### transformToFormData

transformToFormData(value,fields): FormDataRequestBody

Converts an object to a FormDataRequestBody using field definitions.

#### Parameters | Name | Type | Description | | --- | --- | --- | |value^*required|T|The object to convert. | |fields^*required|Array<[FormDataRequestFieldDefinition](#formdatarequestfielddefinition)>|The field definitions for the form data. | #### Returns | Return type | Description | |---|---| |FormDataRequestBody | The resulting form data body.|

### transformToFormDataField

transformToFormDataField(value,field): FormDataRequestField | null

Converts a value to a FormDataRequestField based on the field definition.

#### Parameters | Name | Type | Description | | --- | --- | --- | |value^*required|T|The value to convert. | |field^*required|[FormDataRequestFieldDefinition](#formdatarequestfielddefinition)|The field definition. | #### Returns | Return type | Description | |---|---| |FormDataRequestField \| null | The resulting form data field or null if not required and undefined.|

## Interfaces ### ApiClientOptions Configuration for the API client. #### Properties | Name | Type | | --- | --- | |transformDates^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| ### FormDataRequestFieldDefinition #### Properties | Name | Type | | --- | --- | |key^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |required^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |type^*required|"text" | "json" | "binary"| ### FormDataResponseGenericFieldDefinition #### Properties | Name | Type | | --- | --- | |type^*required|"text" | "binary"| ### FormDataResponseJsonFieldDefinition #### Properties | Name | Type | | --- | --- | |transformations^*required|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | >| |type^*required|"json"| ### ParametersFlags #### Properties | Name | Type | | --- | --- | |explode|Record<[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)>|