77 lines
1.7 KiB
Markdown
77 lines
1.7 KiB
Markdown
---
|
|
title: strings.splitN() function
|
|
description: >
|
|
`strings.splitN()` splits a string on a specified separator and returns an array of `i` substrings.
|
|
menu:
|
|
flux_v0_ref:
|
|
name: strings.splitN
|
|
parent: strings
|
|
identifier: strings/splitN
|
|
weight: 101
|
|
---
|
|
|
|
<!------------------------------------------------------------------------------
|
|
|
|
IMPORTANT: This page was generated from comments in the Flux source code. Any
|
|
edits made directly to this page will be overwritten the next time the
|
|
documentation is generated.
|
|
|
|
To make updates to this documentation, update the function comments above the
|
|
function definition in the Flux source code:
|
|
|
|
https://github.com/influxdata/flux/blob/master/stdlib/strings/strings.flux#L734-L734
|
|
|
|
Contributing to Flux: https://github.com/influxdata/flux#contributing
|
|
Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
|
|
|
|
------------------------------------------------------------------------------->
|
|
|
|
`strings.splitN()` splits a string on a specified separator and returns an array of `i` substrings.
|
|
|
|
|
|
|
|
##### Function type signature
|
|
|
|
```js
|
|
(i: int, t: string, v: string) => [string]
|
|
```
|
|
|
|
{{% caption %}}
|
|
For more information, see [Function type signatures](/flux/v0/function-type-signatures/).
|
|
{{% /caption %}}
|
|
|
|
## Parameters
|
|
|
|
### v
|
|
({{< req >}})
|
|
String value to split.
|
|
|
|
|
|
|
|
### t
|
|
({{< req >}})
|
|
String value that acts as the separator.
|
|
|
|
|
|
|
|
### i
|
|
({{< req >}})
|
|
Maximum number of split substrings to return.
|
|
|
|
`-1` returns all matching substrings.
|
|
The last substring is the unsplit remainder.
|
|
|
|
|
|
## Examples
|
|
|
|
### Split a string into an array of substrings
|
|
|
|
```js
|
|
import "strings"
|
|
|
|
strings.splitN(v: "foo, bar, baz, quz", t: ", ", i: 3)// Returns ["foo", "bar", "baz, quz"]
|
|
|
|
|
|
```
|
|
|