# CXExtensions

**Repository Path**: stevewj/CXExtensions

## Basic Information

- **Project Name**: CXExtensions
- **Description**: No description available
- **Primary Language**: Objective-C
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-07
- **Last Updated**: 2024-06-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CXExtensions

[![GitHub CI](https://github.com/cx-org/CXExtensions/workflows/CI/badge.svg)](https://github.com/cx-org/CXExtensions/actions)
![Install](https://img.shields.io/badge/install-Swift_Package_Manager-ff69b4)
![Supported Platform](https://img.shields.io/badge/platform-Linux%20%7C%20macOS%20%7C%20iOS%20%7C%20watchOS%20%7C%20tvOS-lightgrey)
[![Discord](https://img.shields.io/badge/chat-discord-9cf)](https://discord.gg/9vzqgZx)

A collection of useful extensions for Combine.

CXExtensions is [Combine Compatible Package](https://github.com/cx-org/CombineX/wiki/Combine-Compatible-Package). You're free to switch underlying Combine implementation between [CombineX](https://github.com/cx-org/CombineX) and [Combine](https://developer.apple.com/documentation/combine).

## Installation

Add the following line to the dependencies in your `Package.swift` file:

```swift
.package(url: "https://github.com/cx-org/CXExtensions", .upToNextMinor(from: "0.4.0")),
```

#### Requirements

- Swift 5.0

## Operators

- [IgnoreError](#IgnoreError)
- [WeakAssign](#WeakAssign)
- [Invoke](#Invoke)
- [Signal](#Signal)
- [Blocking](#Blocking)
- [DelayedAutoCancellable](#DelayedAutoCancellable)

---

#### IgnoreError

Ignore error from upstream and complete.

```swift
// Output: (data: Data, response: URLResponse), Failure: URLError
let upstream = URLSession.shared.cx.dataTaskPublisher(for: url)

// Output: (data: Data, response: URLResponse), Failure: Never
let pub = upstream.ignoreError()
```

#### WeakAssign

Like `Subscribers.Assign`, but capture its target weakly.

```swift
pub.assign(to: \.output, weaklyOn: self)
```

#### Invoke

Invoke method on an object with each element from a `Publisher`.

```swift
pub.invoke(handleOutput, weaklyOn: self)
//  Substitute for the following common pattern:
//
//      pub.sink { [weak self] output in
//          self?.handleOutput(output)
//      }
```

#### Signal

Emits a signal (`Void()`) whenever upstream publisher produce an element. It's useful when you want `Invoke` a parameterless handler.

```
// Transform elements to signal first because `handleSignal` accept no argument.
pub.signal().invoke(handleSignal, weaklyOn: self)
```

#### Blocking

Get element from a `Publisher` synchronously. It's useful for command line tool and unit testing.

```swift
let sequence = pub.blocking()
for value in sequence {
    // process value
}
```

#### DelayedAutoCancellable

Auto cancel after delay.

```swift
let delayedCanceller = upstream
    .sink { o in
        print(o)
    }
    .cancel(after .second(1), scheduler: DispatchQueue.main.cx)
```