index.mdx

title	description
Usage	`clkrst` service IPC wrapper for nx.js applications

The @nx.js/clkrst package provides a wrapper for the clkrst service IPC, which allows for adjusting the clock rate of the Switch's CPU, GPU, and memory.

In short, use this package for overclocking your Switch.

Installation

<InstallTabs items={['npm', 'pnpm', 'yarn', 'bun']}>

npm install @nx.js/clkrst

</Tab>
<Tab value="pnpm">

pnpm add @nx.js/clkrst

</Tab>
<Tab value='yarn'>

yarn add @nx.js/clkrst

</Tab>
<Tab value='bun'>

bun add @nx.js/clkrst

</Tab>

Example

import { openSession, PcvModuleId } from '@nx.js/clkrst';

// Create a session for the CPU
const session = openSession(PcvModuleId.CpuBus);

// Get the current clock rate
console.log(session.getClockRate());

// Get list of possible CPU clock rates
const { rates } = session.getPossibleClockRates();

// Overclock CPU **TO THE MAX**
session.setClockRate(rates[rates.length - 1]);