https://github.com/ericlewis/launchdarkly-combine

Combine extensions for LaunchDarkly
https://github.com/ericlewis/launchdarkly-combine

Last synced: 29 days ago
JSON representation

Combine extensions for LaunchDarkly

• Host: GitHub
• URL: https://github.com/ericlewis/launchdarkly-combine
• Owner: ericlewis
• License: mit
• Created: 2020-10-07T17:57:40.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-11-06T15:44:36.000Z (about 1 year ago)
• Last Synced: 2024-10-16T11:52:48.207Z (3 months ago)
• Language: Swift
• Size: 20.5 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LaunchDarkly+Combine

[![SwiftPM compatible](https://img.shields.io/badge/SwiftPM-compatible-informational)](#swift-package-manager)

An easy to use [LaunchDarkly](https://launchdarkly.com) framework that adds support for Combine.

## Requirements

| Platform | Version |

| -------- | ------- |

| iOS      | 13.0    |

| watchOS  | 6.0     |

| tvOS     | 13.0    |

| macOS    | 10.15   |

## Installation

Current support is only for SPM, feel free to open a PR to add other package managers.

### Swift Package Manager

The [Swift Package Manager](https://swift.org/package-manager/) is a dependency manager integrated into the `swift` compiler and Xcode.

To integrate LaunchDarkly+Combine into an Xcode project, go to the project editor, and select `Swift Packages`. From here hit the `+` button and follow the prompts using  `https://github.com/ericlewis/LaunchDarkly-Combine.git` as the URL.

To include LaunchDarkly+Combine in a Swift package, simply add it to the dependencies section of your `Package.swift` file. And add the product "LaunchDarkly+Combine" as a dependency for your targets.

```swift

dependencies: [

    .package(url: "https://github.com/ericlewis/LaunchDarkly-Combine.git", .upToNextMinor(from: "2.0.0"))

]

```

## Example

```swift

import Combine

import LaunchDarkly_Combine

import LaunchDarkly

func observeFlag(key: LDFlagKey) -> AnyPublisher {

    LDClient.get()!

        .variationPublisher(forKey: key)

        .decode()

        .eraseToAnyPublisher()

}

func observeMyBoolFlag() -> AnyPublisher {

   return observeFlag(key: "#FLAG_KEY")

            .replaceError(with: false) // Default value

}

LDClient.start(config: LDConfig(mobileKey: "#YOUR_MOBILE_KEY#"))

var cancellable: AnyCancellable?

cancellable = observeMyBoolFlag()

    .sink {

        print($0)

    }

```

## Project Structure

### Extensions

- Contains the code for extending `LDClient` with Combine.

## License

Copyright (c) 2020 Eric Lewis

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.