# window.Window.split

- **Module:** window
- **Package:** libtmux
- **Language:** TypeScript
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ts/blob/073b9d7dedad900bff6f5ec0ea47794e40225870/packages/libtmux/src/window.ts#L284
- **Page:** https://libtmux.org/en/ts/latest/reference/window-window-split/

```
split(options?: SplitOptions): Promise<Pane>
```

Split this window and resolve the created pane.

## Examples

```ts
import { PaneDirection } from "libtmux";
const created = await window.split({ direction: PaneDirection.Below });
created.id;
```

## Parameters

- `options?` (`SplitOptions`)

## Raises

- [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError): when `options` combines `direction` with `vertical`.

## tmux command

The tmux commands behind `split`.

- [`split-window`](/en/tmux/latest/manual/split-window/)

## tmux C API

The C declarations in tmux that implement these commands.

- [`cmd_split_window_entry`](/en/tmux/latest/reference/c-variable-cmd_split_window_entry/) (attribute)
- [`cmd_split_window_exec`](/en/tmux/latest/reference/c-function-cmd-split-window-c-cmd_split_window_exec/) (function)

Each path starts at a function a command runs, which is degree 1. The degree counts steps from there along the path, and each step is a call or a reference: degree 2 is reached from that function, degree 3 from the next, and so on.

### Split a window

1. [`cmd_split_window_exec`](/en/tmux/latest/reference/c-function-cmd-split-window-c-cmd_split_window_exec/) (function)
2. references → [`spawn_pane`](/en/tmux/latest/reference/c-function-spawn_pane/) (function)
3. calls → [`window_add_pane`](/en/tmux/latest/reference/c-function-window_add_pane/) (function)
4. calls → [`window_pane_create`](/en/tmux/latest/reference/c-function-window-c-window_pane_create/) (function)

## In other ports

Split a window's active pane

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Window.split`](/en/py/latest/reference/libtmux-window-split/) (method) |
| Ruby | [`LibTmux::Window#split`](/en/ruby/latest/reference/libtmux-window-split/) (method) |
| Rust | [`window.Window.split`](/en/rs/latest/reference/window-window-split/) (method) |
| Go | [`tmux.Window.SplitPane`](/en/go/latest/reference/tmux-window-splitpane/) (method) |
| Java | [`io.github.libtmux.Window.split`](/en/java/latest/reference/io-github-libtmux-window-window-split/) (method) |
| Kotlin | [`io.github.libtmux.kotlin.Window.split`](/en/kotlin/latest/reference/io-github-libtmux-kotlin-window-split/) (method) |
| Scala | [`io.github.libtmux.scaladsl.Window.split`](/en/scala/latest/reference/io-github-libtmux-scaladsl-window-split/) (method) |
| C# | [`LibTmux.Window.SplitPaneAsync`](/en/csharp/latest/reference/libtmux-window-splitpaneasync/) (method) |
| C++ | [`libtmux::Window::split`](/en/cxx/latest/reference/libtmux-window-split/) (method) |
| Swift | [`Server.splitWindow(_:direction:size:startDirectory:environment:shell:)`](/en/swift/latest/reference/server-splitwindow(_-direction-size-startdirectory-)/) (method) |

No equivalent is recorded in Lua, PowerShell, Julia, Elixir or F#.