How to store an array of custom objects with DefaultsKit?

Define a Codable struct for your objects and create a key of type Array . DefaultsKit will automatically serialize and deserialize the array using Codable, as demonstrated in the nested objects example with arrays of enums.

DefaultsKit vs SwiftyUserDefaults: which should I use?

DefaultsKit focuses on minimalism and deep Codable integration, while SwiftyUserDefaults offers a richer API with property wrappers. Choose DefaultsKit for simplicity and type safety with Codable; SwiftyUserDefaults if you prefer more syntactic sugar and features.

Can DefaultsKit handle iCloud syncing?

No, DefaultsKit is a wrapper for UserDefaults and does not add iCloud syncing capabilities. You would need to use Apple's NSUbiquitousKeyValueStore separately for cross-device synchronization.

Is DefaultsKit good for storing large amounts of data?

Not recommended, as it inherits UserDefaults' performance issues with large datasets. UserDefaults is designed for small preferences, and DefaultsKit doesn't mitigate this limitation.

How to migrate from raw UserDefaults to DefaultsKit?

Gradually replace UserDefaults calls with DefaultsKit keys. For existing data, read using standard UserDefaults and write using DefaultsKit, but there's no built-in migration tool, so manual handling is required.

Does DefaultsKit support watchOS?

Yes, based on the platform badges in the README, it supports all Apple platforms including watchOS, since it builds on UserDefaults which is available there.

Open-Awesome

UserDefaults

MITSwift0.3.2

A lightweight Swift library providing a simple, strongly typed wrapper for UserDefaults using Codable.

GitHub

1.4k stars91 forks0 contributors

What is UserDefaults?

DefaultsKit is a Swift library that provides a simple, strongly typed wrapper for Apple's UserDefaults. It leverages Swift's Codable protocol to serialize and deserialize complex objects, eliminating the need for manual type casting and reducing boilerplate code in iOS, macOS, and tvOS applications.

Target Audience

Swift developers building apps for Apple platforms (iOS, macOS, tvOS) who need a type-safe and efficient way to store user preferences and app state persistently.

Value Proposition

Developers choose DefaultsKit for its minimal code footprint, compile-time type safety, and seamless integration with Codable, making it a more reliable and developer-friendly alternative to raw UserDefaults.

Overview

Simple, Strongly Typed UserDefaults for iOS, macOS and tvOS

Use Cases

Best For

Storing user preferences with type safety in Swift apps
Persisting Codable structs and enums to UserDefaults
Reducing boilerplate code for UserDefaults management
Ensuring compile-time safety when accessing stored values
Handling nested objects and collections in persistent storage
Simplifying migration from raw UserDefaults to a type-safe solution

Not Ideal For

Apps requiring iCloud synchronization or cross-device data syncing for user preferences
Projects that need to store large, complex datasets beyond UserDefaults' practical limits
Teams looking for a storage solution with built-in data migration and versioning tools
Applications that require advanced querying or relational data management

Pros & Cons

Pros

Compile-Time Type Safety

Keys are generic over value types, preventing type mismatches at compile time, as highlighted in the README's examples with strongly typed keys.

Seamless Codable Integration

Automatically serializes and deserializes any Codable-conforming object, eliminating manual JSON handling for complex structs and enums.

Minimal Code Footprint

Implemented in fewer than 100 lines of code, making it lightweight and easy to integrate without adding bloat to your project.

Efficient Existence Checks

The has() method checks key existence without deserializing values, saving performance for large or nested objects as noted in the README.

Cons

Inherits UserDefaults Limitations

Tied to UserDefaults' constraints, such as size limits and lack of thread-safety guarantees, which can be problematic for scaling or concurrent access.

No Migration Assistance

Does not provide tools for handling schema changes or data migrations, requiring manual effort when app requirements evolve.

Limited to Codable Types

Requires all stored data to conform to Codable, which may necessitate additional work for non-Codable objects or custom serialization needs.

Frequently Asked Questions

Related Projects

MMKV

An efficient, small mobile key-value storage framework developed by WeChat. Works on Android, iOS, macOS, Windows, POSIX, and OHOS.

Realm is a mobile database: a replacement for Core Data & SQLite

Stars16,613

Forks2,238

Last commit2 months ago

FMDB

A Cocoa / Objective-C wrapper around SQLite

Stars13,835

Forks2,731

Last commit5 months ago

WCDB

WCDB is a cross-platform database framework developed by WeChat.

Stars11,634

Forks1,499