SwiftyUserDefaults

Note: What you see below is the old stringly-typed API. If you're using Swift 2, check out the next branch to see what's coming soon.

SwiftyUserDefaults is a set of extensions to make the NSUserDefaults API cleaner, nicer, and at home with Swift's syntax.

Read Swifty APIs: NSUserDefaults for more information about this project.

Fetching data

Defaults["color"].string            // returns String?
Defaults["launchCount"].int         // returns Int?
Defaults["chimeVolume"].double      // returns Double?
Defaults["loggingEnabled"].bool     // returns Bool?
Defaults["lastPaths"].array         // returns NSArray?
Defaults["credentials"].dictionary  // returns NSDictionary?
Defaults["hotkey"].data             // returns NSData?
Defaults["firstLaunchAt"].date      // returns NSDate?
Defaults["anything"].object         // returns NSObject?
Defaults["anything"].number         // returns NSNumber?

SwiftyUserDefaults always returns nil for non-existing values, also for numbers and booleans.

Default values

When you don't want to deal with the nil case, you can use these helpers that return a default value for non-existing defaults:

Defaults["color"].stringValue            // defaults to ""
Defaults["launchCount"].intValue         // defaults to 0
Defaults["chimeVolume"].doubleValue      // defaults to 0.0
Defaults["loggingEnabled"].boolValue     // defaults to false
Defaults["lastPaths"].arrayValue         // defaults to []
Defaults["credentials"].dictionaryValue  // defaults to [:]
Defaults["hotkey"].dataValue             // defaults to NSData()

Setting data

Defaults["color"] = "red"
Defaults["launchCount"] = 0

SwiftyUserDefaults infers the right type when setting values.

Optional assignment

Defaults["color"]            // => nil
Defaults["color"] ?= "white" // => "white"
Defaults["color"] ?= "red"   // => "white"

Works like ||= in other languages — sets value only if the left-hand side value is nil.

Arithmetic

Defaults["launchCount"] += 1
Defaults["launchCount"]++

You can use the += and ++ operators to easily work on integer values in the user defaults. If the key didn't exist before operation, the operators assume it was 0.

Existence

if !Defaults.hasKey("hotkey") {
    Defaults.remove("hotkeyOptions")
}

You can use the hasKey method to check for key's existence in the user defaults. remove() is an alias for removeObjectForKey().

Installation

The simplest way to install this library is to copy SwiftyUserDefaults/SwiftyUserDefaults.swift to your project. There's no step two!

CocoaPods

You can also install this library using CocoaPods. Just add this line to your Podfile:

pod 'SwiftyUserDefaults'

Then import library module like so:

import SwiftyUserDefaults

Note that this requires CocoaPods 0.36+ as well as iOS 8 or OS X 10.9+

Carthage

Just add to your Cartfile:

github "radex/SwiftyUserDefaults"

Biinngg/SwiftyUserDefaults