> For AI agents: the complete documentation index is available at /rspress-russian/llms.txt, the full documentation bundle is available at /rspress-russian/llms-full.txt.

# @rspress/plugin-twoslash 

[Исходный код](https://github.com/web-infra-dev/rspress/tree/main/packages/plugin-twoslash)

Интегрирует [Twoslash](https://github.com/twoslashes/twoslash) в Rspress для генерации расширенных блоков TypeScript-кода с информацией о типах.

## Установка


```sh [npm]
npm add @rspress/plugin-twoslash -D
```

```sh [yarn]
yarn add @rspress/plugin-twoslash -D
```

```sh [pnpm]
pnpm add @rspress/plugin-twoslash -D
```

```sh [bun]
bun add @rspress/plugin-twoslash -D
```

```sh [deno]
deno add npm:@rspress/plugin-twoslash -D
```

## Использование

### 1. Регистрация плагина

```ts twoslash title="rspress.config.ts"
import { defineConfig } from '@rspress/core';
import { pluginTwoslash } from '@rspress/plugin-twoslash';

export default defineConfig({
  plugins: [pluginTwoslash()],
});
```

### 2. Написание блоков кода с twoslash

Используйте специальные комментарии внутри блоков кода TypeScript, чтобы включить возможности Twoslash.

Подробное описание использования — в [официальной документации Twoslash](https://twoslash.netlify.app/guide/).

#### Извлечение типа


**Отрендеренный результат**

```ts twoslash
const hi = 'Hello';
const msg = `${hi}, world`;
//    ^?
```


**Синтаксис**

````mdx
```ts twoslash
const hi = 'Hello';
const msg = `${hi}, world`;
//    ^?
```
````


#### Автодополнения


**Отрендеренный результат**

```ts twoslash
// @noErrors
console.e;
//       ^|
```


**Синтаксис**

````mdx
```ts twoslash
// @noErrors
console.e;
//       ^|
```
````


#### Подсветка


**Отрендеренный результат**

```ts twoslash
function add(a: number, b: number) {
  //     ^^^
  return a + b;
}
```


**Синтаксис**

````mdx
```ts twoslash
function add(a: number, b: number) {
  //     ^^^
  return a + b;
}
```
````


#### Ошибки


**Отрендеренный результат**

```ts twoslash
// @noErrorValidation
const str: string = 1;
```


**Синтаксис**

````mdx
```ts twoslash
// @noErrorValidation
const str: string = 1;
```
````


## Конфигурация

Плагин принимает объект следующего типа:

```ts twoslash
import { TwoslashOptions } from 'twoslash';
// ---cut-before---
export interface PluginTwoslashOptions {
  explicitTrigger?: boolean;
  cache?: boolean;
  twoslashOptions?: TwoslashOptions;
}
```

### explicitTrigger

Параметр `explicitTrigger` определяет, нужно ли явно активировать возможности Twoslash. По умолчанию: `true`.

- Если установить `false` — все блоки кода TypeScript будут обрабатываться Twoslash автоматически.
- Если установить `true` — обрабатываться будут только те блоки кода, в которых указан тег `twoslash`.

### cache

Параметр `cache` включает кэширование языковых серверов TypeScript в зависимости от опций компилятора при вызове [createTwoslasher](https://twoslash.netlify.app/refs/api#createtwoslasher). По умолчанию: `true`.

### twoslashOptions

Параметр `twoslashOptions` позволяет передавать любые опции непосредственно в Twoslash. С его помощью можно настраивать поведение Twoslash, включая опции компилятора TypeScript и другие параметры.
