Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/almazrafi/keyvaluecontainer
Type-safe containers for key-value storage
https://github.com/almazrafi/keyvaluecontainer
carthage cocoapods ios keychain macos spm swift tvos userdefaults watchos xcode
Last synced: about 1 month ago
JSON representation
Type-safe containers for key-value storage
- Host: GitHub
- URL: https://github.com/almazrafi/keyvaluecontainer
- Owner: almazrafi
- License: mit
- Created: 2019-12-21T18:12:46.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-17T06:03:56.000Z (almost 2 years ago)
- Last Synced: 2024-11-18T04:22:57.013Z (about 1 month ago)
- Topics: carthage, cocoapods, ios, keychain, macos, spm, swift, tvos, userdefaults, watchos, xcode
- Language: Swift
- Homepage:
- Size: 74.2 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KeyValueContainer
[](https://github.com/almazrafi/KeyValueContainer/actions)
[](https://codecov.io/gh/almazrafi/KeyValueContainer)
[](http://cocoapods.org/pods/KeyValueContainer)
[](https://github.com/Carthage/Carthage)
[](https://swift.org/package-manager/)
[](https://developer.apple.com/discover/)
[](https://developer.apple.com/xcode)
[](https://swift.org)
[](https://opensource.org/licenses/MIT)
## Requirements
- iOS 12.0+ / macOS 10.14+ / watchOS 5.0+ / tvOS 12.0+
- Xcode 13.0+
- Swift 5.5+
## Usage
#### Declare a container:
``` swift
extension PersistentStorage {
var foobar: KeyValueContainer {
makeContainer()
}
}
```
This will create a container with the same key as property name: "foobar"
#### Reading a value from the storage:
``` swift
let foobar = PersistentStorage.default.foobar.value
```
Same as using UserDefaults:
``` swift
let foobar = UserDefaults.standard.integer(forKey: "foobar")
```
#### Writing a value to the storage:
``` swift
PersistentStorage.default.foobar.value = 123
```
Same as using UserDefaults:
``` swift
UserDefaults.standard.set(123, forKey: "foobar")
```
## Installation
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate KeyValueContainer into your Xcode project using [CocoaPods](http://cocoapods.org), specify it in your `Podfile`:
```ruby
platform :ios, '12.0'
use_frameworks!
target '' do
pod 'KeyValueContainer'
end
```
Finally run the following command:
```bash
$ pod install
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. You can install Carthage with Homebrew using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate KeyValueContainer into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "almazrafi/KeyValueContainer" ~> 1.2.0
```
Finally run `carthage update` to build the framework and drag the built `KeyValueContainer.framework` into your Xcode project.
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.
To integrate KeyValueContainer into your Xcode project using Swift Package Manager,
add the following as a dependency to your `Package.swift`:
```swift
.package(url: "https://github.com/almazrafi/KeyValueContainer.git", from: "1.2.0")
```
and then specify `"KeyValueContainer"` as a dependency of the Target in which you wish to use KeyValueContainer.
Here's an example `Package.swift`:
```swift
// swift-tools-version:5.5
import PackageDescription
let package = Package(
name: "MyPackage",
products: [
.library(name: "MyPackage", targets: ["MyPackage"])
],
dependencies: [
.package(url: "https://github.com/almazrafi/KeyValueContainer.git", from: "1.2.0")
],
targets: [
.target(name: "MyPackage", dependencies: ["KeyValueContainer"])
]
)
```
## Communication
- If you need help, open an issue.
- If you found a bug, open an issue.
- If you have a feature request, open an issue.
- If you want to contribute, submit a pull request.
## License
KeyValueContainer is available under the MIT license. See the [LICENSE](LICENSE) file for more info.