# SwiftString
[](https://travis-ci.org/amayne/SwiftString)
[](http://cocoapods.org/pods/SwiftString)
[](http://cocoapods.org/pods/SwiftString)
[](http://cocoapods.org/pods/SwiftString)
[]()
SwiftString is a lightweight string extension for Swift.
This library was motivated by having to search StackOverflow for common string operations,
and wanting them to be in one place with test coverage.
## Installation
SwiftString is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod "SwiftString"
```
## Usage
```swift
import SwiftString
```
## Methods
**between(left, right)**
```swift
"foo".between("", "") // "foo"
"foo".between("", "") // "foo"
"foo".between("", "") // nil
"Some strings } are very {weird}, dont you think?".between("{", "}") // "weird"
"".between("", "") // nil
"foo".between("", "") // nil
```
**camelize()**
```swift
"os version".camelize() // "osVersion"
"HelloWorld".camelize() // "helloWorld"
"someword With Characters".camelize() // "somewordWithCharacters"
"data_rate".camelize() // "dataRate"
"background-color".camelize() // "backgroundColor"
```
**capitalize()**
```swift
"hello world".capitalize() // "Hello World"
```
**chompLeft(string)**
```swift
"foobar".chompLeft("foo") // "bar"
"foobar".chompLeft("bar") // "foo"
```
**chompRight(string)**
```swift
"foobar".chompRight("bar") // "foo"
"foobar".chompRight("foo") // "bar"
```
**collapseWhitespace()**
```swift
" String \t libraries are \n\n\t fun\n! ".collapseWhitespace() // "String libraries are fun !")
```
**contains(substring)**
```swift
"foobar".contains("foo") // true
"foobar".contains("bar") // true
"foobar".contains("something") // false
```
**count(string)**
```swift
"hi hi ho hey hihey".count("hi") // 3
```
**decodeHTML()**
```swift
"The Weekend ‘King Of The Fall’".decodeHTML() // "The Weekend ‘King Of The Fall’"
" 4 < 5 & 3 > 2 . Price: 12 €. @ ".decodeHTML() // " 4 < 5 & 3 > 2 . Price: 12 €. @ "
"this is so "good"".decodeHTML() // "this is so \"good\""
```
**endsWith(suffix)**
```swift
"hello world".endsWith("world") // true
"hello world".endsWith("foo") // false
```
**ensureLeft(prefix)**
```swift
"/subdir".ensureLeft("/") // "/subdir"
"subdir".ensureLeft("/") // "/subdir"
```
**ensureRight(suffix)**
```swift
"subdir/".ensureRight("/") // "subdir/"
"subdir".ensureRight("/") // "subdir/"
```
**indexOf(substring)**
```swift
"hello".indexOf("hell"), // 0
"hello".indexOf("lo"), // 3
"hello".indexOf("world") // nil
```
**initials()**
```swift
"First".initials(), // "F"
"First Last".initials(), // "FL"
"First Middle1 Middle2 Middle3 Last".initials() // "FMMML"
```
**initialsFirstAndLast()**
```swift
"First Last".initialsFirstAndLast(), // "FL"
"First Middle1 Middle2 Middle3 Last".initialsFirstAndLast() // "FL"
```
**isAlpha()**
```swift
"fdafaf3".isAlpha() // false
"afaf".isAlpha() // true
"dfdf--dfd".isAlpha() // false
```
**isAlphaNumeric()**
```swift
"afaf35353afaf".isAlphaNumeric() // true
"FFFF99fff".isAlphaNumeric() // true
"99".isAlphaNumeric() // true
"afff".isAlphaNumeric() // true
"-33".isAlphaNumeric() // false
"aaff..".isAlphaNumeric() // false
```
**isEmpty()**
```swift
" ".isEmpty() // true
"\t\t\t ".isEmpty() // true
"\n\n".isEmpty() // true
"helo".isEmpty() // false
```
**isNumeric()**
```swift
"abc".isNumeric() // false
"123a".isNumeric() // false
"1".isNumeric() // true
"22".isNumeric() // true
"33.0".isNumeric() // true
"-63.0".isNumeric() // true
```
**join(sequence)**
```swift
",".join([1,2,3]) // "1,2,3"
",".join([]) // ""
",".join(["a","b","c"]) // "a,b,c"
"! ".join(["hey","who are you?"]) // "hey! who are you?"
```
**latinize()**
```swift
"šÜįéïöç".latinize() // "sUieioc"
"crème brûlée".latinize() // "creme brulee"
```
**lines()**
```swift
"test".lines() // ["test"]
"test\nsentence".lines() // ["test", "sentence"]
"test \nsentence".lines() // ["test ", "sentence"]
```
**pad(n, string)**
```swift
"hello".pad(2) // " hello "
"hello".pad(1, "\t") // "\thello\t"
```
**padLeft(n, string)**
```swift
"hello".padLeft(10) // " hello"
"what?".padLeft(2, "!") // "!!what?"
```
**padRight(n, string)**
```swift
"hello".padRight(10) // "hello "
"hello".padRight(2, "!") // "hello!!"
```
**startsWith(prefix)**
```swift
"hello world".startsWith("hello") // true
"hello world".startsWith("foo") // false
```
**split(separator)**
```swift
"hello world".split(" ")[0] // "hello"
"hello world".split(" ")[1] // "world"
"helloworld".split(" ")[0] // "helloworld"
```
**times(n)**
```swift
"hi".times(3) // "hihihi"
" ".times(10) // " "
```
**toBool()**
```swift
"asdwads".toBool() // nil
"true".toBool() // true
"false".toBool() // false
```
**toFloat()**
```swift
"asdwads".toFloat() // nil
"2.00".toFloat() // 2.0
"2".toFloat() // 2.0
```
**toInt()**
```swift
"asdwads".toInt() // nil
"2.00".toInt() // 2
"2".toInt() // 2
```
**toDate()**
```swift
"asdwads".toDate() // nil
"2014-06-03".toDate() // NSDate
```
**toDateTime()**
```swift
"asdwads".toDateTime() // nil
"2014-06-03 13:15:01".toDateTime() // NSDate
```
**toDouble()**
```swift
"asdwads".toDouble() // nil
"2.00".toDouble() // 2.0
"2".toDouble() // 2.0
```
**trimmedLeft()**
```swift
" How are you? ".trimmedLeft() // "How are you? "
```
**trimmedRight()**
```swift
" How are you? ".trimmedRight() // " How are you?"
```
**trimmed()**
```swift
" How are you? ".trimmed() // "How are you?"
```
**slugify()**
```swift
"Global Thermonuclear Warfare".slugify() // "global-thermonuclear-warfare"
"Crème brûlée".slugify() // "creme-brulee"
```
**stripPunctuation()**
```swift
"My, st[ring] *full* of %punct)".stripPunctuation() // "My string full of punct"
```
**substring(startIndex, length)**
```swift
"hello world".substring(0, length: 1) // "h"
"hello world".substring(0, length: 11) // "hello world"
```
**[subscript]**
```swift
"hello world"[0...1] // "he"
"hello world"[0..<1] // "h"
"hello world"[0] // "h"
"hello world"[0...10] // "hello world"
```
## Author
Andrew Mayne, andrew@redbricklab.com
## License
SwiftString is available under the MIT license. See the LICENSE file for more info.