nushell/docs/commands/each_window.md
Justin Ma c0a1d18e3d
update #4455, regenerate commands' docs and update make_docs script (#4586)
* feat: update #4455, regenerate commands' docs

* chore: update make_docs script
2022-02-21 11:26:00 -06:00

29 lines
627 B
Markdown

---
title: each window
layout: command
version: 0.59.0
---
Runs a block on window groups of `window_size` that slide by n rows.
## Signature
```> each window (window_size) (block) --stride```
## Parameters
- `window_size`: the size of each window
- `block`: the block to run on each window
- `--stride {int}`: the number of rows to slide over between windows
## Examples
A sliding window of two elements
```shell
> echo [1 2 3 4] | each window 2 { |it| $it.0 + $it.1 }
```
A sliding window of two elements, with a stride of 3
```shell
> [1, 2, 3, 4, 5, 6, 7, 8] | each window 2 --stride 3 { |x| $x.0 + $x.1 }
```