diff options
| author | Will Hopkins <willothyh@gmail.com> | 2023-12-12 12:27:24 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-12-12 14:27:24 -0600 |
| commit | 69ffbb76c237fcbba24de80f1b5346d92642e800 (patch) | |
| tree | f6a59d9e31dedaff08b08a183e5484d04ee50d3f /runtime/doc | |
| parent | 1907abb4c27857fe7f4e7394f32e130f9955a2e7 (diff) | |
| download | rneovim-69ffbb76c237fcbba24de80f1b5346d92642e800.tar.gz rneovim-69ffbb76c237fcbba24de80f1b5346d92642e800.tar.bz2 rneovim-69ffbb76c237fcbba24de80f1b5346d92642e800.zip | |
feat(iter): add `Iter.take` (#26525)
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/lua.txt | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index f7f722bc0e..7e0ad5f4c3 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -3639,6 +3639,25 @@ Iter:slice({first}, {last}) *Iter:slice()* Return: ~ Iter +Iter:take({n}) *Iter:take()* + Transforms an iterator to yield only the first n values. + + Example: >lua + local it = vim.iter({ 1, 2, 3, 4 }):take(2) + it:next() + -- 1 + it:next() + -- 2 + it:next() + -- nil +< + + Parameters: ~ + • {n} (integer) + + Return: ~ + Iter + Iter:totable() *Iter:totable()* Collect the iterator into a table. |