# normalizeTerminalKey

Source: /tuil/docs/reference/packages/hotkeys/api/normalize-terminal-key
Locale: en

function exported by @mwillbanks/tuil-hotkeys.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-hotkeys`.

```ts
export function normalizeTerminalKey(
  input: string,
  key: TerminalKey = {},
  platform: NodeJS.Platform = process.platform,
): string;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member     | Type              | Required | Description                                         | Related types                                                      |
| ---------- | ----------------- | -------- | --------------------------------------------------- | ------------------------------------------------------------------ |
| `input`    | `string`          | Yes      | Supplies the `input` value as `string`.             | —                                                                  |
| `key`      | `TerminalKey`     | No       | Supplies the `key` value as `TerminalKey`.          | [`TerminalKey`](/tuil/docs/reference/packages/hotkeys/api/terminal-key) |
| `platform` | `NodeJS.Platform` | No       | Supplies the `platform` value as `NodeJS.Platform`. | —                                                                  |

## Returns [#returns]

`string` — Returns a value that satisfies `string`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TerminalKey`](/tuil/docs/reference/packages/hotkeys/api/terminal-key)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/hotkeys/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-hotkeys](/tuil/docs/reference/packages/hotkeys)