> 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-client-redirects 

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

Служит для клиентских редиректов.

:::warning
Перед использованием этого плагина убедитесь, что в вашей среде развёртывания правильно настроена страница возврата. Подробнее см. в руководстве [SSG refresh-404](/rspress-russian/guide/basic/ssg.md#refresh-404).

Обратите внимание: клиентские редиректы отличаются от серверных — страница сначала загружается, а затем перенаправляется (что вызывает кратковременную вспышку), и SSR не поддерживается. Если ваша платформа развёртывания поддерживает серверные редиректы (301/302), лучше использовать их для лучшего SEO и удобства пользователей.
:::

## Установка


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

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

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

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

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

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

Добавьте следующую конфигурацию в файл `rspress.config.ts`:

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

export default defineConfig({
  plugins: [
    pluginClientRedirects({
      redirects: [
        {
          from: '/docs/old1',
          to: '/docs/new1',
        },
      ],
    }),
  ],
});
```

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

Плагин принимает объект с настройками. Доступные свойства этого объекта:

```ts
type RedirectRule = {
  from: string | string[];
  to: string;
};

type RedirectsOptions = {
  redirects?: RedirectRule[];
};
```

`from` — это путь-шаблон для сопоставления, `to` — путь, на который будет выполнен редирект. Поддерживаются строки с регулярными выражениями.

:::note Примечание

Один `to` может обслуживать несколько `from`: все они будут перенаправляться на один и тот же путь.

Один `from` не может соответствовать нескольким `to`: путь редиректа должен быть уникальным и однозначным.

:::

## Пример

```ts
import path from 'node:path';
import { defineConfig } from '@rspress/core';
import { pluginClientRedirects } from '@rspress/plugin-client-redirects';

export default defineConfig({
  root: path.join(__dirname, 'doc'),
  plugins: [
    pluginClientRedirects({
      redirects: [
        // /docs/old1 -> /docs/new1
        {
          from: '/docs/old1',
          to: '/docs/new1',
        },
        // перенаправление с нескольких старых путей на новый путь
        {
          from: ['/docs/2022', '/docs/2023'],
          to: '/docs/2024',
        },
        // перенаправление с использованием регулярных выражений
        {
          from: '^/docs/old2',
          to: '/docs/new2',
        },
        {
          from: '/docs/old3$',
          to: '/docs/new3',
        },
        // перенаправление на внешний URL
        {
          from: '/docs/old4',
          to: 'https://example.com',
        },
      ],
    }),
  ],
});
```
