---
name: "Regex.split"
section: "3kaya"
platform: "linux"
package: "kaya"
version: "0.4.4-6.2"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/Regex.split"
---

# Regex.split(3kaya)

Split a string into substrings.

## NAME

Regex::split - Split a string into substrings.

## SYNOPSIS

**\[String\] split(** *Regex pattre, String str, Int limit=0, Bool allowempty=false* **)**

## ARGUMENTS

**pattre** A compiled regular expression

**str** The String to split

**limit** The maximum number of pieces (from the left) to split **str**  into. If this is parameter is omitted or set to zero an unlimited number of pieces will be allowed.

**allowempty** If this is true, then consecutive delimeters will be treated as having an empty string between them. If it is false (or omitted) then consecutive delimeters will be treated as one.

## DESCRIPTION

Using **pattre**  as a delimeter, split **str**  into substrings.

## AUTHORS

Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/

## LICENSE

The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.

## RELATED

**Regex.compile (3kaya)**

**Regex.split\_1 (3kaya)**