# useHotkeyRecorder

```ts
function useHotkeyRecorder(options): OctaneHotkeyRecorder;
```

Defined in: [useHotkeyRecorder.ts:9](https://github.com/TanStack/hotkeys/blob/main/packages/octane-hotkeys/src/useHotkeyRecorder.ts#L9)

Records a shortcut and destroys the recorder on unmount.

## Parameters

### options

`HotkeyRecorderOptions`

## Returns

[`OctaneHotkeyRecorder`](../interfaces/OctaneHotkeyRecorder.md)