# pane.Pane.split

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

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

Split this pane and resolve the created pane.

## Examples

```ts
import { PaneDirection } from "libtmux";
const created = await pane.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 pane in two

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Pane.split`](/en/py/latest/reference/libtmux-pane-split/) (method) |
| Ruby | [`LibTmux::Pane#split`](/en/ruby/latest/reference/libtmux-pane-split/) (method) |
| Lua | [`libtmux.Pane:split`](/en/lua/latest/reference/libtmux-pane-split/) (method) |
| Rust | [`pane.Pane.split`](/en/rs/latest/reference/pane-pane-split/) (method) |
| Go | [`tmux.Pane.Split`](/en/go/latest/reference/tmux-pane-split/) (method) |
| Java | [`io.github.libtmux.Pane.split`](/en/java/latest/reference/io-github-libtmux-pane-pane-split/) (method) |
| Kotlin | [`io.github.libtmux.kotlin.Pane.split`](/en/kotlin/latest/reference/io-github-libtmux-kotlin-pane-split/) (method) |
| Scala | [`io.github.libtmux.scaladsl.Pane.split`](/en/scala/latest/reference/io-github-libtmux-scaladsl-pane-split/) (method) |
| C# | [`LibTmux.Pane.SplitAsync`](/en/csharp/latest/reference/libtmux-pane-splitasync/) (method) |
| C++ | no direct pane target; Window.split splits the active pane |
| Swift | [`Server.split(_:direction:size:startDirectory:environment:shell:)`](/en/swift/latest/reference/server-split(_-direction-size-startdirectory-)/) (method) |

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