App Services · IOS API REFERENCE

Combine

Customize handling of asynchronous events by combining event-processing operators.

309 types

181 callable entries

657 skipped

22% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

AnyCancellable

class · iOS 13.0+

AnyPublisher

struct · iOS 13.0+

AnySubscriber

struct · iOS 13.0+

AsyncPublisher

struct · iOS 15.0+

AsyncPublisher.AsyncIterator

typealias · iOS 15.0+

AsyncPublisher.Element

typealias · iOS 15.0+

AsyncPublisher.Iterator

struct · iOS 15.0+

AsyncPublisher.Iterator.Element

typealias · iOS 15.0+

AsyncThrowingPublisher

struct · iOS 15.0+

AsyncThrowingPublisher.AsyncIterator

typealias · iOS 15.0+

AsyncThrowingPublisher.Element

typealias · iOS 15.0+

AsyncThrowingPublisher.Iterator

struct · iOS 15.0+

AsyncThrowingPublisher.Iterator.Element

typealias · iOS 15.0+

Cancellable

protocol · iOS 13.0+

CombineIdentifier

struct · iOS 13.0+

ConnectablePublisher

protocol · iOS 13.0+

CurrentValueSubject

class · iOS 13.0+

CustomCombineIdentifierConvertible

protocol · iOS 13.0+

Deferred

struct · iOS 13.0+

Deferred.Failure

typealias · iOS 13.0+

Deferred.Output

typealias · iOS 13.0+

Empty

struct · iOS 13.0+

Fail

struct · iOS 13.0+

Future

class · iOS 13.0+

Future.Promise

typealias · iOS 13.0+

ImmediateScheduler

struct · iOS 13.0+

ImmediateScheduler.SchedulerOptions

typealias · iOS 13.0+

ImmediateScheduler.SchedulerTimeType

struct · iOS 13.0+

ImmediateScheduler.SchedulerTimeType.Stride

struct · iOS 13.0+

ImmediateScheduler.SchedulerTimeType.Stride.FloatLiteralType

typealias · iOS 13.0+

ImmediateScheduler.SchedulerTimeType.Stride.IntegerLiteralType

typealias · iOS 13.0+

ImmediateScheduler.SchedulerTimeType.Stride.Magnitude

typealias · iOS 13.0+

Just

struct · iOS 13.0+

Just.Failure

typealias · iOS 13.0+

ObservableObject

protocol · iOS 13.0+

ObservableObjectPublisher

class · iOS 13.0+

ObservableObjectPublisher.Failure

typealias · iOS 13.0+

ObservableObjectPublisher.Output

typealias · iOS 13.0+

Optional.Publisher

struct · iOS 13.0+

Optional.Publisher.Failure

typealias · iOS 13.0+

Optional.Publisher.Output

typealias · iOS 13.0+

PassthroughSubject

class · iOS 13.0+

Published

struct · iOS 13.0+

Published.Publisher

struct · iOS 13.0+

Published.Publisher.Failure

typealias · iOS 13.0+

Published.Publisher.Output

typealias · iOS 13.0+

Publisher

protocol · iOS 13.0+

Publishers

enum · iOS 13.0+

Publishers.AllSatisfy

struct · iOS 13.0+

Publishers.AllSatisfy.Failure

typealias · iOS 13.0+

Publishers.AllSatisfy.Output

typealias · iOS 13.0+

Publishers.AssertNoFailure

struct · iOS 13.0+

Publishers.AssertNoFailure.Failure

typealias · iOS 13.0+

Publishers.AssertNoFailure.Output

typealias · iOS 13.0+

Publishers.Autoconnect

class · iOS 13.0+

Publishers.Autoconnect.Failure

typealias · iOS 13.0+

Publishers.Autoconnect.Output

typealias · iOS 13.0+

Publishers.Breakpoint

struct · iOS 13.0+

Publishers.Breakpoint.Failure

typealias · iOS 13.0+

Publishers.Breakpoint.Output

typealias · iOS 13.0+

Publishers.Buffer

struct · iOS 13.0+

Publishers.Buffer.Failure

typealias · iOS 13.0+

Publishers.Buffer.Output

typealias · iOS 13.0+

Publishers.BufferingStrategy

enum · iOS 13.0+

Publishers.Catch

struct · iOS 13.0+

Publishers.Catch.Failure

typealias · iOS 13.0+

Publishers.Catch.Output

typealias · iOS 13.0+

Publishers.Collect

struct · iOS 13.0+

Publishers.Collect.Failure

typealias · iOS 13.0+

Publishers.Collect.Output

typealias · iOS 13.0+

Publishers.CollectByCount

struct · iOS 13.0+

Publishers.CollectByCount.Failure

typealias · iOS 13.0+

Publishers.CollectByCount.Output

typealias · iOS 13.0+

Publishers.CollectByTime

struct · iOS 13.0+

Publishers.CollectByTime.Failure

typealias · iOS 13.0+

Publishers.CollectByTime.Output

typealias · iOS 13.0+

Publishers.CombineLatest

struct · iOS 13.0+

Publishers.CombineLatest.Failure

typealias · iOS 13.0+

Publishers.CombineLatest.Output

typealias · iOS 13.0+

Publishers.CombineLatest3

struct · iOS 13.0+

Publishers.CombineLatest3.Failure

typealias · iOS 13.0+

Publishers.CombineLatest3.Output

typealias · iOS 13.0+

Publishers.CombineLatest4

struct · iOS 13.0+

Publishers.CombineLatest4.Failure

typealias · iOS 13.0+

Publishers.CombineLatest4.Output

typealias · iOS 13.0+

Publishers.CompactMap

struct · iOS 13.0+

Publishers.CompactMap.Failure

typealias · iOS 13.0+

Publishers.Comparison

struct · iOS 13.0+

Publishers.Comparison.Failure

typealias · iOS 13.0+

Publishers.Comparison.Output

typealias · iOS 13.0+

Publishers.Concatenate

struct · iOS 13.0+

Publishers.Concatenate.Failure

typealias · iOS 13.0+

Publishers.Concatenate.Output

typealias · iOS 13.0+

Publishers.Contains

struct · iOS 13.0+

Publishers.Contains.Failure

typealias · iOS 13.0+

Publishers.Contains.Output

typealias · iOS 13.0+

Publishers.ContainsWhere

struct · iOS 13.0+

Publishers.ContainsWhere.Failure

typealias · iOS 13.0+

Publishers.ContainsWhere.Output

typealias · iOS 13.0+

Publishers.Count

struct · iOS 13.0+

Publishers.Count.Failure

typealias · iOS 13.0+

Publishers.Count.Output

typealias · iOS 13.0+

Publishers.Debounce

struct · iOS 13.0+

Publishers.Debounce.Failure

typealias · iOS 13.0+

Publishers.Debounce.Output

typealias · iOS 13.0+

Publishers.Decode

struct · iOS 13.0+

Publishers.Decode.Failure

typealias · iOS 13.0+

Publishers.Delay

struct · iOS 13.0+

Publishers.Delay.Failure

typealias · iOS 13.0+

Publishers.Delay.Output

typealias · iOS 13.0+

Publishers.Drop

struct · iOS 13.0+

Publishers.Drop.Failure

typealias · iOS 13.0+

Publishers.Drop.Output

typealias · iOS 13.0+

Publishers.DropUntilOutput

struct · iOS 13.0+

Publishers.DropUntilOutput.Failure

typealias · iOS 13.0+

Publishers.DropUntilOutput.Output

typealias · iOS 13.0+

Publishers.DropWhile

struct · iOS 13.0+

Publishers.DropWhile.Failure

typealias · iOS 13.0+

Publishers.DropWhile.Output

typealias · iOS 13.0+

Publishers.Encode

struct · iOS 13.0+

Publishers.Encode.Failure

typealias · iOS 13.0+

Publishers.Encode.Output

typealias · iOS 13.0+

Publishers.Filter

struct · iOS 13.0+

Publishers.Filter.Failure

typealias · iOS 13.0+

Publishers.Filter.Output

typealias · iOS 13.0+

Publishers.First

struct · iOS 13.0+

Publishers.First.Failure

typealias · iOS 13.0+

Publishers.First.Output

typealias · iOS 13.0+

Publishers.FirstWhere

struct · iOS 13.0+

Publishers.FirstWhere.Failure

typealias · iOS 13.0+

Publishers.FirstWhere.Output

typealias · iOS 13.0+

Publishers.FlatMap

struct · iOS 13.0+

Publishers.FlatMap.Failure

typealias · iOS 13.0+

Publishers.FlatMap.Output

typealias · iOS 13.0+

Publishers.HandleEvents

struct · iOS 13.0+

Publishers.HandleEvents.Failure

typealias · iOS 13.0+

Publishers.HandleEvents.Output

typealias · iOS 13.0+

Publishers.IgnoreOutput

struct · iOS 13.0+

Publishers.IgnoreOutput.Failure

typealias · iOS 13.0+

Publishers.IgnoreOutput.Output

typealias · iOS 13.0+

Publishers.Last

struct · iOS 13.0+

Publishers.Last.Failure

typealias · iOS 13.0+

Publishers.Last.Output

typealias · iOS 13.0+

Publishers.LastWhere

struct · iOS 13.0+

Publishers.LastWhere.Failure

typealias · iOS 13.0+

Publishers.LastWhere.Output

typealias · iOS 13.0+

Publishers.MakeConnectable

struct · iOS 13.0+

Publishers.MakeConnectable.Failure

typealias · iOS 13.0+

Publishers.MakeConnectable.Output

typealias · iOS 13.0+

Publishers.Map

struct · iOS 13.0+

Publishers.Map.Failure

typealias · iOS 13.0+

Publishers.MapError

struct · iOS 13.0+

Publishers.MapError.Output

typealias · iOS 13.0+

Publishers.MapKeyPath

struct · iOS 13.0+

Publishers.MapKeyPath.Failure

typealias · iOS 13.0+

Publishers.MapKeyPath2

struct · iOS 13.0+

Publishers.MapKeyPath2.Failure

typealias · iOS 13.0+

Publishers.MapKeyPath2.Output

typealias · iOS 13.0+

Publishers.MapKeyPath3

struct · iOS 13.0+

Publishers.MapKeyPath3.Failure

typealias · iOS 13.0+

Publishers.MapKeyPath3.Output

typealias · iOS 13.0+

Publishers.MeasureInterval

struct · iOS 13.0+

Publishers.MeasureInterval.Failure

typealias · iOS 13.0+

Publishers.MeasureInterval.Output

typealias · iOS 13.0+

Publishers.Merge

struct · iOS 13.0+

Publishers.Merge.Failure

typealias · iOS 13.0+

Publishers.Merge.Output

typealias · iOS 13.0+

Publishers.Merge3

struct · iOS 13.0+

Publishers.Merge3.Failure

typealias · iOS 13.0+

Publishers.Merge3.Output

typealias · iOS 13.0+

Publishers.Merge4

struct · iOS 13.0+

Publishers.Merge4.Failure

typealias · iOS 13.0+

Publishers.Merge4.Output

typealias · iOS 13.0+

Publishers.Merge5

struct · iOS 13.0+

Publishers.Merge5.Failure

typealias · iOS 13.0+

Publishers.Merge5.Output

typealias · iOS 13.0+

Publishers.Merge6

struct · iOS 13.0+

Publishers.Merge6.Failure

typealias · iOS 13.0+

Publishers.Merge6.Output

typealias · iOS 13.0+

Publishers.Merge7

struct · iOS 13.0+

Publishers.Merge7.Failure

typealias · iOS 13.0+

Publishers.Merge7.Output

typealias · iOS 13.0+

Publishers.Merge8

struct · iOS 13.0+

Publishers.Merge8.Failure

typealias · iOS 13.0+

Publishers.Merge8.Output

typealias · iOS 13.0+

Publishers.MergeMany

struct · iOS 13.0+

Publishers.MergeMany.Failure

typealias · iOS 13.0+

Publishers.MergeMany.Output

typealias · iOS 13.0+

Publishers.Multicast

class · iOS 13.0+

Publishers.Multicast.Failure

typealias · iOS 13.0+

Publishers.Multicast.Output

typealias · iOS 13.0+

Publishers.Output

struct · iOS 13.0+

Publishers.Output.Failure

typealias · iOS 13.0+

Publishers.Output.Output

typealias · iOS 13.0+

Publishers.PrefetchStrategy

enum · iOS 13.0+

Publishers.PrefixUntilOutput

struct · iOS 13.0+

Publishers.PrefixUntilOutput.Failure

typealias · iOS 13.0+

Publishers.PrefixUntilOutput.Output

typealias · iOS 13.0+

Publishers.PrefixWhile

struct · iOS 13.0+

Publishers.PrefixWhile.Failure

typealias · iOS 13.0+

Publishers.PrefixWhile.Output

typealias · iOS 13.0+

Publishers.Print

struct · iOS 13.0+

Publishers.Print.Failure

typealias · iOS 13.0+

Publishers.Print.Output

typealias · iOS 13.0+

Publishers.ReceiveOn

struct · iOS 13.0+

Publishers.ReceiveOn.Failure

typealias · iOS 13.0+

Publishers.ReceiveOn.Output

typealias · iOS 13.0+

Publishers.Reduce

struct · iOS 13.0+

Publishers.Reduce.Failure

typealias · iOS 13.0+

Publishers.RemoveDuplicates

struct · iOS 13.0+

Publishers.RemoveDuplicates.Failure

typealias · iOS 13.0+

Publishers.RemoveDuplicates.Output

typealias · iOS 13.0+

Publishers.ReplaceEmpty

struct · iOS 13.0+

Publishers.ReplaceEmpty.Failure

typealias · iOS 13.0+

Publishers.ReplaceEmpty.Output

typealias · iOS 13.0+

Publishers.ReplaceError

struct · iOS 13.0+

Publishers.ReplaceError.Failure

typealias · iOS 13.0+

Publishers.ReplaceError.Output

typealias · iOS 13.0+

Publishers.Retry

struct · iOS 13.0+

Publishers.Retry.Failure

typealias · iOS 13.0+

Publishers.Retry.Output

typealias · iOS 13.0+

Publishers.Scan

struct · iOS 13.0+

Publishers.Scan.Failure

typealias · iOS 13.0+

Publishers.Sequence

struct · iOS 13.0+

Publishers.Sequence.Output

typealias · iOS 13.0+

Publishers.SetFailureType

struct · iOS 13.0+

Publishers.SetFailureType.Output

typealias · iOS 13.0+

Publishers.Share

class · iOS 13.0+

Publishers.Share.Failure

typealias · iOS 13.0+

Publishers.Share.Output

typealias · iOS 13.0+

Publishers.SubscribeOn

struct · iOS 13.0+

Publishers.SubscribeOn.Failure

typealias · iOS 13.0+

Publishers.SubscribeOn.Output

typealias · iOS 13.0+

Publishers.SwitchToLatest

struct · iOS 13.0+

Publishers.SwitchToLatest.Failure

typealias · iOS 13.0+

Publishers.SwitchToLatest.Output

typealias · iOS 13.0+

Publishers.Throttle

struct · iOS 13.0+

Publishers.Throttle.Failure

typealias · iOS 13.0+

Publishers.Throttle.Output

typealias · iOS 13.0+

Publishers.TimeGroupingStrategy

enum · iOS 13.0+

Publishers.Timeout

struct · iOS 13.0+

Publishers.Timeout.Failure

typealias · iOS 13.0+

Publishers.Timeout.Output

typealias · iOS 13.0+

Publishers.TryAllSatisfy

struct · iOS 13.0+

Publishers.TryAllSatisfy.Failure

typealias · iOS 13.0+

Publishers.TryAllSatisfy.Output

typealias · iOS 13.0+

Publishers.TryCatch

struct · iOS 13.0+

Publishers.TryCatch.Failure

typealias · iOS 13.0+

Publishers.TryCatch.Output

typealias · iOS 13.0+

Publishers.TryCompactMap

struct · iOS 13.0+

Publishers.TryCompactMap.Failure

typealias · iOS 13.0+

Publishers.TryComparison

struct · iOS 13.0+

Publishers.TryComparison.Failure

typealias · iOS 13.0+

Publishers.TryComparison.Output

typealias · iOS 13.0+

Publishers.TryContainsWhere

struct · iOS 13.0+

Publishers.TryContainsWhere.Failure

typealias · iOS 13.0+

Publishers.TryContainsWhere.Output

typealias · iOS 13.0+

Publishers.TryDropWhile

struct · iOS 13.0+

Publishers.TryDropWhile.Failure

typealias · iOS 13.0+

Publishers.TryDropWhile.Output

typealias · iOS 13.0+

Publishers.TryFilter

struct · iOS 13.0+

Publishers.TryFilter.Failure

typealias · iOS 13.0+

Publishers.TryFilter.Output

typealias · iOS 13.0+

Publishers.TryFirstWhere

struct · iOS 13.0+

Publishers.TryFirstWhere.Failure

typealias · iOS 13.0+

Publishers.TryFirstWhere.Output

typealias · iOS 13.0+

Publishers.TryLastWhere

struct · iOS 13.0+

Publishers.TryLastWhere.Failure

typealias · iOS 13.0+

Publishers.TryLastWhere.Output

typealias · iOS 13.0+

Publishers.TryMap

struct · iOS 13.0+

Publishers.TryMap.Failure

typealias · iOS 13.0+

Publishers.TryPrefixWhile

struct · iOS 13.0+

Publishers.TryPrefixWhile.Failure

typealias · iOS 13.0+

Publishers.TryPrefixWhile.Output

typealias · iOS 13.0+

Publishers.TryReduce

struct · iOS 13.0+

Publishers.TryReduce.Failure

typealias · iOS 13.0+

Publishers.TryRemoveDuplicates

struct · iOS 13.0+

Publishers.TryRemoveDuplicates.Failure

typealias · iOS 13.0+

Publishers.TryRemoveDuplicates.Output

typealias · iOS 13.0+

Publishers.TryScan

struct · iOS 13.0+

Publishers.TryScan.Failure

typealias · iOS 13.0+

Publishers.Zip

struct · iOS 13.0+

Publishers.Zip.Failure

typealias · iOS 13.0+

Publishers.Zip.Output

typealias · iOS 13.0+

Publishers.Zip3

struct · iOS 13.0+

Publishers.Zip3.Failure

typealias · iOS 13.0+

Publishers.Zip3.Output

typealias · iOS 13.0+

Publishers.Zip4

struct · iOS 13.0+

Publishers.Zip4.Failure

typealias · iOS 13.0+

Publishers.Zip4.Output

typealias · iOS 13.0+

Record

struct · iOS 13.0+

Record.Recording

struct · iOS 13.0+

Record.Recording.Input

typealias · iOS 13.0+

Result.Publisher

struct · iOS 13.0+

Result.Publisher.Output

typealias · iOS 13.0+

Scheduler

protocol · iOS 13.0+

SchedulerTimeIntervalConvertible

protocol · iOS 13.0+

Subject

protocol · iOS 13.0+

Subscriber

protocol · iOS 13.0+

Subscribers

enum · iOS 13.0+

Subscribers.Assign

class · iOS 13.0+

Subscribers.Assign.Failure

typealias · iOS 13.0+

Subscribers.Completion

enum · iOS 13.0+

Subscribers.Demand

struct · iOS 13.0+

Subscribers.Sink

class · iOS 13.0+

Subscription

protocol · iOS 13.0+

Subscriptions

enum · iOS 13.0+

TopLevelDecoder

protocol · iOS 13.0+

TopLevelEncoder

protocol · iOS 13.0+

Functions and constants

get · iOS 13.0+

receiveCompletion

TypeScript

get receiveCompletion(): (((arg0: Subscribers_Completion<SDKHandle>) => Promise<boolean>)) | null

Swift declaration

let receiveCompletion: ((Subscribers.Completion<Publishers.Breakpoint<Upstream>.Failure>) -> Bool)?

A closure that executes when the publisher receives completion, and can raise a debugger signal by returning a true Boolean value.

get · iOS 13.0+

receiveSubscription

TypeScript

get receiveSubscription(): (((arg0: SDKHandle) => Promise<boolean>)) | null

Swift declaration

let receiveSubscription: ((any Subscription) -> Bool)?

A closure that executes when the publisher receives a subscription, and can raise a debugger signal by returning a true Boolean value.

get · iOS 13.0+

predicate

TypeScript

get predicate(): ((arg0: SDKHandle) => Promise<boolean>)

Swift declaration

let predicate: (Publishers.FirstWhere<Upstream>.Output) -> Bool

The closure that determines whether to publish an element.

init · iOS 13.0+

init

TypeScript

static init(upstream: _Foundation_Timer_TimerPublisher): Publishers_Autoconnect<_Foundation_Timer_TimerPublisher>

Swift declaration

init(upstream: Upstream)

Creates a publisher that automatically connects to an upstream connectable publisher. - Parameter upstream: The publisher from which this publisher receives elements.

get · iOS 13.0+

upstream

TypeScript

get upstream(): _Foundation_Timer_TimerPublisher

Swift declaration

final let upstream: Upstream

The publisher from which this publisher receives elements.

get · iOS 13.0+

predicate

TypeScript

get predicate(): ((arg0: SDKHandle) => Promise<boolean>)

Swift declaration

let predicate: (Publishers.PrefixWhile<Upstream>.Output) -> Bool

The closure that determines whether publishing should continue.

get · iOS 13.0+

receiveCancel

TypeScript

get receiveCancel(): ((() => Promise<void>)) | null

Swift declaration

var receiveCancel: (() -> Void)?

A closure that executes when the downstream receiver cancels publishing.

set · iOS 13.0+

receiveCancel

TypeScript

set receiveCancel(value: ((() => void)) | null)

Swift declaration

var receiveCancel: (() -> Void)?

A closure that executes when the downstream receiver cancels publishing.

get · iOS 13.0+

receiveOutput

TypeScript

get receiveOutput(): (((arg0: SDKHandle) => Promise<void>)) | null

Swift declaration

var receiveOutput: ((Publishers.HandleEvents<Upstream>.Output) -> Void)?

A closure that executes when the publisher receives a value from the upstream publisher.

set · iOS 13.0+

receiveOutput

TypeScript

set receiveOutput(value: (((arg0: SDKHandle) => void)) | null)

Swift declaration

var receiveOutput: ((Publishers.HandleEvents<Upstream>.Output) -> Void)?

A closure that executes when the publisher receives a value from the upstream publisher.

get · iOS 13.0+

receiveRequest

TypeScript

get receiveRequest(): (((arg0: Subscribers_Demand) => Promise<void>)) | null

Swift declaration

var receiveRequest: ((Subscribers.Demand) -> Void)?

A closure that executes when the publisher receives a request for more elements.

set · iOS 13.0+

receiveRequest

TypeScript

set receiveRequest(value: (((arg0: Subscribers_Demand) => void)) | null)

Swift declaration

var receiveRequest: ((Subscribers.Demand) -> Void)?

A closure that executes when the publisher receives a request for more elements.

get · iOS 13.0+

receiveCompletion

TypeScript

get receiveCompletion(): (((arg0: Subscribers_Completion<SDKHandle>) => Promise<void>)) | null

Swift declaration

var receiveCompletion: ((Subscribers.Completion<Publishers.HandleEvents<Upstream>.Failure>) -> Void)?

A closure that executes when the upstream publisher finishes normally or terminates with an error.

set · iOS 13.0+

receiveCompletion

TypeScript

set receiveCompletion(value: (((arg0: Subscribers_Completion<SDKHandle>) => void)) | null)

Swift declaration

var receiveCompletion: ((Subscribers.Completion<Publishers.HandleEvents<Upstream>.Failure>) -> Void)?

A closure that executes when the upstream publisher finishes normally or terminates with an error.

get · iOS 13.0+

receiveSubscription

TypeScript

get receiveSubscription(): (((arg0: SDKHandle) => Promise<void>)) | null

Swift declaration

var receiveSubscription: ((any Subscription) -> Void)?

A closure that executes when the publisher receives the subscription from the upstream publisher.

set · iOS 13.0+

receiveSubscription

TypeScript

set receiveSubscription(value: (((arg0: SDKHandle) => void)) | null)

Swift declaration

var receiveSubscription: ((any Subscription) -> Void)?

A closure that executes when the publisher receives the subscription from the upstream publisher.

get · iOS 13.0+

output

TypeScript

get output(): SDKHandle

Swift declaration

let output: Publishers.ReplaceEmpty<Upstream>.Output

The element to deliver when the upstream publisher finishes without delivering any elements.

get · iOS 13.0+

output

TypeScript

get output(): SDKHandle

Swift declaration

let output: Publishers.ReplaceError<Upstream>.Output

The element with which to replace errors from the upstream publisher.

get · iOS 13.0+

predicate

TypeScript

get predicate(): ((arg0: SDKHandle) => Promise<boolean>)

Swift declaration

let predicate: (Publishers.TryDropWhile<Upstream>.Output) throws -> Bool

The error-throwing closure that indicates whether to drop the element.

get · iOS 13.0+

predicate

TypeScript

get predicate(): ((arg0: SDKHandle) => Promise<boolean>)

Swift declaration

let predicate: (Publishers.TryLastWhere<Upstream>.Output) throws -> Bool

The error-throwing closure that determines whether to publish an element.

get · iOS 13.0+

strategy

TypeScript

get strategy(): Publishers_TimeGroupingStrategy<SDKHandle>

Swift declaration

let strategy: Publishers.TimeGroupingStrategy<Context>

The strategy with which to collect and publish elements.

get · iOS 13.0+

predicate

TypeScript

get predicate(): ((arg0: SDKHandle) => Promise<boolean>)

Swift declaration

let predicate: (Publishers.TryFirstWhere<Upstream>.Output) throws -> Bool

The error-throwing closure that determines whether to publish an element.

get · iOS 13.0+

count

TypeScript

get count(): number

Swift declaration

let count: Int

The maximum number of received elements to buffer before publishing.

get · iOS 13.0+

predicate

TypeScript

get predicate(): ((arg0: SDKHandle) => Promise<boolean>)

Swift declaration

let predicate: (Publishers.TryPrefixWhile<Upstream>.Output) throws -> Bool

The error-throwing closure that determines whether publishing should continue.

get · iOS 13.0+

file

TypeScript

get file(): SDKHandle

Swift declaration

let file: StaticString

The filename used in the error message.

get · iOS 13.0+

line

TypeScript

get line(): number

Swift declaration

let line: UInt

The line number used in the error message.

get · iOS 13.0+

prefix

TypeScript

get prefix(): string

Swift declaration

let prefix: String

The string used at the beginning of the fatal error message.

method · iOS 13.0+

connect

TypeScript

connect(): SDKHandle

Swift declaration

func connect() -> any Cancellable

Connects to the publisher, allowing it to produce elements, and returns an instance with which to cancel publishing. - Returns: A ``Cancellable`` instance that you use to cancel publishing.

get · iOS 13.0+

predicate

TypeScript

get predicate(): ((arg0: SDKHandle, arg1: SDKHandle) => Promise<boolean>)

Swift declaration

let predicate: (Publishers.RemoveDuplicates<Upstream>.Output, Publishers.RemoveDuplicates<Upstream>.Output) -> Bool

The predicate closure used to evaluate whether two elements are duplicates.

get · iOS 13.0+

predicate

TypeScript

get predicate(): ((arg0: SDKHandle, arg1: SDKHandle) => Promise<boolean>)

Swift declaration

let predicate: (Publishers.TryRemoveDuplicates<Upstream>.Output, Publishers.TryRemoveDuplicates<Upstream>.Output) throws -> Bool

An error-throwing closure to evaluate whether two elements are equivalent, for purposes of filtering.

get · iOS 13.0+

count

TypeScript

get count(): number

Swift declaration

let count: Int

The number of elements to drop.

get · iOS 13.0+

initialResult

TypeScript

get initialResult(): unknown

Swift declaration

let initialResult: Output

The previous result returned by the `nextPartialResult` closure.

get · iOS 13.0+

prefix

TypeScript

get prefix(): string

Swift declaration

let prefix: String

A string with which to prefix all log messages.

get · iOS 13.0+

stream

TypeScript

get stream(): (SDKHandle) | null

Swift declaration

let stream: (any TextOutputStream)?

get · iOS 13.0+

retries

TypeScript

get retries(): (number) | null

Swift declaration

let retries: Int?

The maximum number of retry attempts to perform. If `nil`, this publisher attempts to reconnect with the upstream publisher an unlimited number of times.

get · iOS 13.0+

size

TypeScript

get size(): number

Swift declaration

let size: Int

The maximum number of elements to store.

get · iOS 13.0+

prefetch

TypeScript

get prefetch(): Publishers_PrefetchStrategy

Swift declaration

let prefetch: Publishers.PrefetchStrategy

The strategy for initially populating the buffer.

get · iOS 13.0+

whenFull

TypeScript

get whenFull(): Publishers_BufferingStrategy<SDKHandle>

Swift declaration

let whenFull: Publishers.BufferingStrategy<Publishers.Buffer<Upstream>.Failure>

The action to take when the buffer becomes full.

get · iOS 13.0+

range

TypeScript

get range(): SDKHandle

Swift declaration

let range: CountableRange<Int>

The range of elements to publish.

get · iOS 13.0+

initial

TypeScript

get initial(): unknown

Swift declaration

let initial: Output

The initial value provided on the first invocation of the closure.

get · iOS 13.0+

maxPublishers

TypeScript

get maxPublishers(): Subscribers_Demand

Swift declaration

let maxPublishers: Subscribers.Demand

The maximum number of concurrent publisher subscriptions

get · iOS 13.0+

customError

TypeScript

get customError(): ((() => Promise<SDKHandle>)) | null

Swift declaration

let customError: (() -> Publishers.Timeout<Upstream, Context>.Failure)?

A closure that executes if the publisher times out. The publisher sends the failure returned by this closure to the subscriber as the reason for termination.

get · iOS 13.0+

initialResult

TypeScript

get initialResult(): unknown

Swift declaration

let initialResult: Output

The previous result returned by the `nextPartialResult` closure.

get · iOS 13.0+

output

TypeScript

get output(): number

Swift declaration

let output: Upstream.Output

The element to match in the upstream publisher.

method · iOS 13.0+

tryContains

TypeScript

tryContains(predicate: ((arg0: SDKHandle) => boolean)): Result_Publisher<boolean, NativeError>

Swift declaration

func tryContains(where predicate: (Publishers.Sequence<Elements, Failure>.Output) throws -> Bool) -> Result<Bool, any Error>.Publisher

method · iOS 13.0+

ignoreOutput

TypeScript

ignoreOutput(): Empty<SDKHandle, NativeError>

Swift declaration

func ignoreOutput() -> Empty<Publishers.Sequence<Elements, Failure>.Output, Failure>

method · iOS 13.0+

tryAllSatisfy

TypeScript

tryAllSatisfy(predicate: ((arg0: SDKHandle) => boolean)): Result_Publisher<boolean, NativeError>

Swift declaration

func tryAllSatisfy(_ predicate: (Publishers.Sequence<Elements, Failure>.Output) throws -> Bool) -> Result<Bool, any Error>.Publisher

method · iOS 13.0+

prefix

TypeScript

prefix(maxLength: number): Publishers_Sequence<SDKHandle, NativeError>

Swift declaration

func prefix(_ maxLength: Int) -> Publishers.Sequence<PrefixSequence<Elements>, Failure>

method · iOS 13.0+

collect

TypeScript

collect(): Result_Publisher<Array<SDKHandle>, NativeError>

Swift declaration

func collect() -> Result<[Publishers.Sequence<Elements, Failure>.Output], Failure>.Publisher

method · iOS 13.0+

dropFirst

TypeScript

dropFirst(count?: number): Publishers_Sequence<SDKHandle, NativeError>

Swift declaration

func dropFirst(_ count: Int = 1) -> Publishers.Sequence<DropFirstSequence<Elements>, Failure>

method · iOS 13.0+

removeDuplicates

TypeScript

removeDuplicates(): Publishers_Sequence<Array<number>, NativeError>

Swift declaration

func removeDuplicates() -> Publishers.Sequence<[Publishers.Sequence<Elements, Failure>.Output], Failure>

method · iOS 13.0+

contains

TypeScript

contains(output: number): Result_Publisher<boolean, NativeError>

Swift declaration

func contains(_ output: Elements.Element) -> Result<Bool, Failure>.Publisher

get · iOS 13.0+

latest

TypeScript

get latest(): boolean

Swift declaration

let latest: Bool

A Boolean value indicating whether to publish the most recent element. If `false`, the publisher emits the first element received during the interval.

get · iOS 13.0+

predicate

TypeScript

get predicate(): ((arg0: SDKHandle) => Promise<boolean>)

Swift declaration

let predicate: (Publishers.DropWhile<Upstream>.Output) -> Bool

The closure that indicates whether to drop the element.

get · iOS 13.0+

predicate

TypeScript

get predicate(): ((arg0: SDKHandle) => Promise<boolean>)

Swift declaration

let predicate: (Publishers.LastWhere<Upstream>.Output) -> Bool

The closure that determines whether to publish an element.

method · iOS 13.0+

connect

TypeScript

connect(): SDKHandle

Swift declaration

final func connect() -> any Cancellable

Connects to the publisher, allowing it to produce elements, and returns an instance with which to cancel publishing. - Returns: A ``Cancellable`` instance that you use to cancel publishing.

get · iOS 13.0+

initial

TypeScript

get initial(): unknown

Swift declaration

let initial: Output

The initial value provided on the first-use of the closure.

get · iOS 13.0+

description

TypeScript

get description(): string

Swift declaration

final var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

get · iOS 13.0+

customMirror

TypeScript

get customMirror(): SDKHandle

Swift declaration

final var customMirror: Mirror { get }

The custom mirror for this instance. If this type has value semantics, the mirror should be unaffected by subsequent mutations of the instance.

get · iOS 13.0+

receiveValue

TypeScript

get receiveValue(): ((arg0: unknown) => Promise<void>)

Swift declaration

final var receiveValue: (Input) -> Void { get }

The closure to execute on receipt of a value.

init · iOS 13.0+

init

TypeScript

static init(receiveCompletion: ((arg0: Subscribers_Completion<NativeError>) => void), receiveValue: ((arg0: unknown) => void)): Subscribers_Sink<unknown, NativeError>

Swift declaration

init(receiveCompletion: @escaping (Subscribers.Completion<Failure>) -> Void, receiveValue: @escaping (Input) -> Void)

Initializes a sink with the provided closures. - Parameters: - receiveCompletion: The closure to execute on completion. - receiveValue: The closure to execute on receipt of a value.

get · iOS 13.0+

receiveCompletion

TypeScript

get receiveCompletion(): ((arg0: Subscribers_Completion<NativeError>) => Promise<void>)

Swift declaration

final var receiveCompletion: (Subscribers.Completion<Failure>) -> Void { get }

The closure to execute on completion.

get · iOS 13.0+

playgroundDescription

TypeScript

get playgroundDescription(): unknown

Swift declaration

final var playgroundDescription: Any { get }

A custom playground description for this instance.

method · iOS 13.0+

cancel

TypeScript

cancel(): void

Swift declaration

final func cancel()

Cancel the activity. When implementing ``Cancellable`` in support of a custom publisher, implement `cancel()` to request that your publisher stop calling its downstream subscribers. Combine doesn't require that the publisher stop immediately, but the `cancel()` call should take effect quickly. Canceling should also eliminate any strong references it currently holds. After you receive one call to `cancel()`, subsequent calls shouldn't do anything. Additionally, your implementation must be thread-safe, and it shouldn't block the caller. > Tip: Keep in mind that your `cancel()` may execute concurrently with another call to `cancel()` --- including the scenario where an ``AnyCancellable`` is deallocating --- or to ``Subscription/request(_:)``.

method · iOS 13.0+

receive

TypeScript

receiveCompletion88476(completion: Subscribers_Completion<NativeError>): void

Swift declaration

final func receive(completion: Subscribers.Completion<Failure>)

Tells the subscriber that the publisher has completed publishing, either normally or with an error. - Parameter completion: A ``Subscribers/Completion`` case indicating whether publishing completed normally or with an error.

method · iOS 13.0+

receive

TypeScript

receiveSubscription(subscription: SDKHandle): void

Swift declaration

final func receive(subscription: any Subscription)

Tells the subscriber that it has successfully subscribed to the publisher and may request items. Use the received ``Subscription`` to request items from the publisher. - Parameter subscription: A subscription that represents the connection between publisher and subscriber.

method · iOS 13.0+

receive

TypeScript

receive(value: unknown): Subscribers_Demand

Swift declaration

final func receive(_ value: Input) -> Subscribers.Demand

Tells the subscriber that the publisher has produced an element. - Parameter input: The published element. - Returns: A `Subscribers.Demand` instance indicating how many more elements the subscriber expects to receive.

get · iOS 13.0+

description

TypeScript

get description(): string

Swift declaration

final var description: String { get }

A textual representation of this subscriber.

get · iOS 13.0+

customMirror

TypeScript

get customMirror(): SDKHandle

Swift declaration

final var customMirror: Mirror { get }

A mirror that reflects the subscriber.

get · iOS 13.0+

playgroundDescription

TypeScript

get playgroundDescription(): unknown

Swift declaration

final var playgroundDescription: Any { get }

A custom playground description for this subscriber.

method · iOS 13.0+

cancel

TypeScript

cancel(): void

Swift declaration

final func cancel()

Cancel the activity.

init · iOS 13.0+

init

TypeScript

static init(object: unknown, keyPath: SDKHandle): Subscribers_Assign<unknown, unknown>

Swift declaration

init(object: Root, keyPath: ReferenceWritableKeyPath<Root, Input>)

Creates a subscriber to assign the value of a property indicated by a key path. - Parameters: - object: The object that contains the property. The subscriber assigns the object’s property every time it receives a new value. - keyPath: A key path that indicates the property to assign. See [Key-Path Expression](https://developer.apple.com/library/archive/documentation/Swift/Conceptual/Swift_Programming_Language/Expressions.html#//apple_ref/doc/uid/TP40014097-CH32-ID563) in _The Swift Programming Language_ to learn how to use key paths to specify a property of an object.

get · iOS 13.0+

object

TypeScript

get object(): (unknown) | null

Swift declaration

final var object: Root? { get }

The object that contains the property to assign. The subscriber holds a strong reference to this object until the upstream publisher calls ``Subscriber/receive(completion:)``, at which point the subscriber sets this property to `nil`.

get · iOS 13.0+

keyPath

TypeScript

get keyPath(): SDKHandle

Swift declaration

final let keyPath: ReferenceWritableKeyPath<Root, Input>

The key path that indicates the property to assign.

method · iOS 13.0+

receive

TypeScript

receiveCompletion(completion: Subscribers_Completion<never>): void

Swift declaration

final func receive(completion: Subscribers.Completion<Never>)

method · iOS 13.0+

receive

TypeScript

receiveSubscription(subscription: SDKHandle): void

Swift declaration

final func receive(subscription: any Subscription)

method · iOS 13.0+

receive

TypeScript

receive(value: unknown): Subscribers_Demand

Swift declaration

final func receive(_ value: Input) -> Subscribers.Demand

Tells the subscriber that the publisher has produced an element. A ``Subscribers/Demand`` instance indicating how many more elements the subscriber expects to receive. - Parameter input: The published element.

get · iOS 13.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

get · iOS 13.0+

playgroundDescription

TypeScript

get playgroundDescription(): unknown

Swift declaration

var playgroundDescription: Any { get }

A custom playground description for this instance.

get · iOS 13.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

get · iOS 13.0+

customMirror

TypeScript

get customMirror(): SDKHandle

Swift declaration

var customMirror: Mirror { get }

The custom mirror for this instance. If this type has value semantics, the mirror should be unaffected by subsequent mutations of the instance.

get · iOS 13.0+

combineIdentifier

TypeScript

get combineIdentifier(): CombineIdentifier

Swift declaration

let combineIdentifier: CombineIdentifier

A unique identifier for identifying publisher streams.

init · iOS 13.0+

init

TypeScript

static init(receiveSubscription?: (((arg0: SDKHandle) => void)) | null, receiveCompletion?: (((arg0: Subscribers_Completion<NativeError>) => void)) | null): AnySubscriber<unknown, NativeError>

Swift declaration

init(receiveSubscription: ((any Subscription) -> Void)? = nil, receiveValue: ((Input) -> Subscribers.Demand)? = nil, receiveCompletion: ((Subscribers.Completion<Failure>) -> Void)? = nil)

Creates a type-erasing subscriber that executes the provided closures. - Parameters: - receiveSubscription: A closure to execute when the subscriber receives the initial subscription from the publisher. - receiveValue: A closure to execute when the subscriber receives a value from the publisher. - receiveCompletion: A closure to execute when the subscriber receives a completion callback from the publisher.

get · iOS 13.0+

playgroundDescription

TypeScript

get playgroundDescription(): unknown

Swift declaration

var playgroundDescription: Any { get }

A custom playground description for this instance.

method · iOS 13.0+

receive

TypeScript

receiveCompletion(completion: Subscribers_Completion<NativeError>): void

Swift declaration

func receive(completion: Subscribers.Completion<Failure>)

method · iOS 13.0+

receive

TypeScript

receiveSubscription(subscription: SDKHandle): void

Swift declaration

func receive(subscription: any Subscription)

method · iOS 13.0+

receive

TypeScript

receive(value: unknown): Subscribers_Demand

Swift declaration

func receive(_ value: Input) -> Subscribers.Demand

method · iOS 15.0+

makeAsyncIterator

TypeScript

makeAsyncIterator(): AsyncPublisher_Iterator<SDKHandle>

Swift declaration

func makeAsyncIterator() -> AsyncPublisher<P>.Iterator

Creates the asynchronous iterator that produces elements of this asynchronous sequence. - Returns: An instance of the `AsyncIterator` type used to produce elements of the asynchronous sequence.

method · iOS 13.0+

send

TypeScript

sendCompletion(completion: Subscribers_Completion<NativeError>): void

Swift declaration

final func send(completion: Subscribers.Completion<Failure>)

Sends a completion signal to the subscriber. - Parameter completion: A `Completion` instance which indicates whether publishing has finished normally or failed with an error.

method · iOS 13.0+

send

TypeScript

sendSubscription(subscription: SDKHandle): void

Swift declaration

final func send(subscription: any Subscription)

Sends a subscription to the subscriber. This call provides the ``Subject`` an opportunity to establish demand for any new upstream subscriptions. - Parameter subscription: The subscription instance through which the subscriber can request elements.

method · iOS 13.0+

send

TypeScript

send(input: unknown): void

Swift declaration

final func send(_ input: Output)

Sends a value to the subscriber. - Parameter value: The value to send.

init · iOS 13.0+

init

TypeScript

static init(): PassthroughSubject<unknown, NativeError>

Swift declaration

init()

method · iOS 13.0+

send

TypeScript

sendCompletion(completion: Subscribers_Completion<NativeError>): void

Swift declaration

final func send(completion: Subscribers.Completion<Failure>)

Sends a completion signal to the subscriber. - Parameter completion: A `Completion` instance which indicates whether publishing has finished normally or failed with an error.

method · iOS 13.0+

send

TypeScript

sendSubscription(subscription: SDKHandle): void

Swift declaration

final func send(subscription: any Subscription)

method · iOS 13.0+

send

TypeScript

send(input: unknown): void

Swift declaration

final func send(_ input: Output)

Sends a value to the subscriber. - Parameter value: The value to send.

get · iOS 13.0+

value

TypeScript

get value(): unknown

Swift declaration

final var value: Output { get set }

The value wrapped by this subject, published as a new element whenever it changes.

set · iOS 13.0+

value

TypeScript

set value(value: unknown)

Swift declaration

final var value: Output { get set }

The value wrapped by this subject, published as a new element whenever it changes.

init · iOS 13.0+

init

TypeScript

static init(value: unknown): CurrentValueSubject<unknown, NativeError>

Swift declaration

init(_ value: Output)

Creates a current value subject with the given initial value. - Parameter value: The initial value to publish.

method · iOS 15.0+

makeAsyncIterator

TypeScript

makeAsyncIterator(): AsyncThrowingPublisher_Iterator<SDKHandle>

Swift declaration

func makeAsyncIterator() -> AsyncThrowingPublisher<P>.Iterator

Creates the asynchronous iterator that produces elements of this asynchronous sequence. - Returns: An instance of the `AsyncIterator` type used to produce elements of the asynchronous sequence.

init · iOS 13.0+

init

TypeScript

static init(error: NativeError): Fail<unknown, NativeError>

Swift declaration

init(error: Failure)

Creates a publisher that immediately terminates with the specified failure. - Parameter error: The failure to send when terminating the publisher.

get · iOS 13.0+

error

TypeScript

get error(): NativeError

Swift declaration

let error: Failure

The failure to send when terminating the publisher.

method · iOS 13.0+

tryContains

TypeScript

tryContains(predicate: ((arg0: unknown) => boolean)): Result_Publisher<boolean, NativeError>

Swift declaration

func tryContains(where predicate: (Output) throws -> Bool) -> Result<Bool, any Error>.Publisher

method · iOS 13.0+

ignoreOutput

TypeScript

ignoreOutput(): Empty<unknown, never>

Swift declaration

func ignoreOutput() -> Empty<Output, Just<Output>.Failure>

method · iOS 13.0+

replaceEmpty

TypeScript

replaceEmpty(output: unknown): Just<unknown>

Swift declaration

func replaceEmpty(with output: Output) -> Just<Output>

method · iOS 13.0+

replaceError

TypeScript

replaceError(output: unknown): Just<unknown>

Swift declaration

func replaceError(with output: Output) -> Just<Output>

method · iOS 13.0+

tryAllSatisfy

TypeScript

tryAllSatisfy(predicate: ((arg0: unknown) => boolean)): Result_Publisher<boolean, NativeError>

Swift declaration

func tryAllSatisfy(_ predicate: (Output) throws -> Bool) -> Result<Bool, any Error>.Publisher

method · iOS 13.0+

tryRemoveDuplicates

TypeScript

tryRemoveDuplicates(predicate: ((arg0: unknown, arg1: unknown) => boolean)): Result_Publisher<unknown, NativeError>

Swift declaration

func tryRemoveDuplicates(by predicate: (Output, Output) throws -> Bool) -> Result<Output, any Error>.Publisher

method · iOS 13.0+

last

TypeScript

last(): Just<unknown>

Swift declaration

func last() -> Just<Output>

method · iOS 13.0+

count

TypeScript

count(): Just<number>

Swift declaration

func count() -> Just<Int>

method · iOS 13.0+

first

TypeScript

first(): Just<unknown>

Swift declaration

func first() -> Just<Output>

method · iOS 13.0+

retry

TypeScript

retry(times: number): Just<unknown>

Swift declaration

func retry(_ times: Int) -> Just<Output>

method · iOS 13.0+

output

TypeScript

outputAt(index: number): Optional_Publisher<unknown>

Swift declaration

func output(at index: Int) -> Optional<Output>.Publisher

method · iOS 13.0+

output

TypeScript

outputIn(range: SDKHandle): Optional_Publisher<unknown>

Swift declaration

func output<R>(in range: R) -> Optional<Output>.Publisher where R : RangeExpression, R.Bound == Int

get · iOS 13.0+

output

TypeScript

get output(): unknown

Swift declaration

let output: Output

The one element that the publisher emits.

method · iOS 13.0+

prefix

TypeScript

prefix(maxLength: number): Optional_Publisher<unknown>

Swift declaration

func prefix(_ maxLength: Int) -> Optional<Output>.Publisher

method · iOS 13.0+

tryMap

TypeScript

tryMap(transform: ((arg0: unknown) => unknown)): Result_Publisher<unknown, NativeError>

Swift declaration

func tryMap<T>(_ transform: (Output) throws -> T) -> Result<T, any Error>.Publisher

method · iOS 13.0+

collect

TypeScript

collect(): Just<Array<unknown>>

Swift declaration

func collect() -> Just<[Output]>

method · iOS 13.0+

tryScan

TypeScript

tryScan(initialResult: unknown, nextPartialResult: ((arg0: unknown, arg1: unknown) => unknown)): Result_Publisher<unknown, NativeError>

Swift declaration

func tryScan<T>(_ initialResult: T, _ nextPartialResult: (T, Output) throws -> T) -> Result<T, any Error>.Publisher

method · iOS 13.0+

dropFirst

TypeScript

dropFirst(count?: number): Optional_Publisher<unknown>

Swift declaration

func dropFirst(_ count: Int = 1) -> Optional<Output>.Publisher

method · iOS 13.0+

tryReduce

TypeScript

tryReduce(initialResult: unknown, nextPartialResult: ((arg0: unknown, arg1: unknown) => unknown)): Result_Publisher<unknown, NativeError>

Swift declaration

func tryReduce<T>(_ initialResult: T, _ nextPartialResult: (T, Output) throws -> T) -> Result<T, any Error>.Publisher

method · iOS 13.0+

removeDuplicates

TypeScript

removeDuplicates(): Just<number>

Swift declaration

func removeDuplicates() -> Just<Output>

method · iOS 13.0+

contains

TypeScript

contains(output: number): Just<boolean>

Swift declaration

func contains(_ output: Output) -> Just<Bool>

init · iOS 13.0+

init

TypeScript

static init(output: unknown): Just<unknown>

Swift declaration

init(_ output: Output)

Initializes a publisher that emits the specified output just once. - Parameter output: The one element that the publisher emits.

init · iOS 13.0+

init

TypeScript

static init(completeImmediately?: boolean): Empty<unknown, NativeError>

Swift declaration

init(completeImmediately: Bool = true)

Creates an empty publisher. - Parameter completeImmediately: A Boolean value that indicates whether the publisher should immediately finish.

get · iOS 13.0+

completeImmediately

TypeScript

get completeImmediately(): boolean

Swift declaration

let completeImmediately: Bool

A Boolean value that indicates whether the publisher immediately sends a completion. If `true`, the publisher finishes immediately after sending a subscription to the subscriber. If `false`, it never completes.

get · iOS 15.0+

value

TypeScript

get value(): Promise<unknown>

Swift declaration

final var value: Output { get async throws }

The published value of the future or an error, delivered asynchronously. This property subscribes to the `Future` and delivers the value asynchronously when the `Future` publishes it. If the `Future` terminates with an error, the awaiting caller receives the error instead. Use this property when you want to the `async`-`await` syntax with a `Future` whose ``Publisher/Failure`` type is not <doc://com.apple.documentation/documentation/Swift/Never>.

get · iOS 15.0+

value

TypeScript

get value70286(): Promise<unknown>

Swift declaration

final var value: Output { get async }

The published value of the future, delivered asynchronously. This property subscribes to the `Future` and delivers the value asynchronously when the `Future` publishes it. Use this property when you want to use the `async`-`await` syntax with a `Future`.

init · iOS 13.0+

init

TypeScript

static init(attemptToFulfill: ((arg0: ((arg0: SDKHandle) => Promise<void>)) => void)): Future<unknown, NativeError>

Swift declaration

init(_ attemptToFulfill: @escaping (@escaping Future<Output, Failure>.Promise) -> Void)

Creates a publisher that invokes a promise closure when the publisher emits an element. - Parameter attemptToFulfill: A ``Future/Promise`` that the publisher invokes when the publisher emits an element or terminates with an error.

init · iOS 13.0+

init

TypeScript

static initOutputCompletion(output: Array<unknown>, completion: Subscribers_Completion<NativeError>): Record<unknown, NativeError>

Swift declaration

init(output: [Output], completion: Subscribers.Completion<Failure>)

Creates a record publisher to publish the provided elements, followed by the provided completion value. - Parameters: - output: An array of output elements to publish. - completion: The completion value with which to end publishing.

init · iOS 13.0+

init

TypeScript

static initRecord(record: ((arg0: Record_Recording<unknown, NativeError>) => void)): Record<unknown, NativeError>

Swift declaration

init(record: (inout Record<Output, Failure>.Recording) -> Void)

Creates a publisher to interactively record a series of outputs and a completion. - Parameter record: A recording instance that can be retrieved after completion to create new record publishers to replay the recording.

get · iOS 13.0+

completion

TypeScript

get completion(): Subscribers_Completion<NativeError>

Swift declaration

var completion: Subscribers.Completion<Failure> { get }

The completion which will be sent to a `Subscriber`.

init · iOS 13.0+

init

TypeScript

static initOutputCompletion(output: Array<unknown>, completion?: Subscribers_Completion<NativeError>): Record_Recording<unknown, NativeError>

Swift declaration

init(output: [Output], completion: Subscribers.Completion<Failure> = .finished)

Set up a complete recording with the specified output and completion.

get · iOS 13.0+

output

TypeScript

get output(): Array<unknown>

Swift declaration

var output: [Output] { get }

The output which will be sent to a `Subscriber`.

method · iOS 13.0+

receive

TypeScript

receiveCompletion(completion: Subscribers_Completion<NativeError>): void

Swift declaration

mutating func receive(completion: Subscribers.Completion<Failure>)

Add a completion to the recording. A `fatalError` will be raised if more than one completion is added.

method · iOS 13.0+

receive

TypeScript

receive(input: unknown): void

Swift declaration

mutating func receive(_ input: Record<Output, Failure>.Recording.Input)

Add an output to the recording. A `fatalError` will be raised if output is added after adding completion.

init · iOS 13.0+

init

TypeScript

static init(): Record_Recording<unknown, NativeError>

Swift declaration

init()

Set up a recording in a state ready to receive output.

get · iOS 13.0+

recording

TypeScript

get recording(): Record_Recording<unknown, NativeError>

Swift declaration

let recording: Record<Output, Failure>.Recording

The recorded output and completion.

init · iOS 13.0+

init

TypeScript

static initRecording(recording: Record_Recording<unknown, NativeError>): Record<unknown, NativeError>

Swift declaration

init(recording: Record<Output, Failure>.Recording)

Creates a record publisher from an existing recording. - Parameter recording: A previously-recorded recording of published elements and a completion.

init · iOS 13.0+

init

TypeScript

static initInitialValue(initialValue: unknown): Published<unknown>

Swift declaration

init(initialValue: Value)

Creates the published instance with an initial value. Don't use this initializer directly. Instead, create a property with the `@Published` attribute, as shown here: @Published var lastUpdated: Date = Date() - Parameter initialValue: The publisher's initial value.

init · iOS 13.0+

init

TypeScript

static initWrappedValue(wrappedValue: unknown): Published<unknown>

Swift declaration

init(wrappedValue: Value)

Creates the published instance with an initial wrapped value. Don't use this initializer directly. Instead, create a property with the `@Published` attribute, as shown here: @Published var lastUpdated: Date = Date() - Parameter wrappedValue: The publisher's initial value.

set · iOS 13.0+

projectedValue

TypeScript

set projectedValue(value: Published_Publisher<unknown>)

Swift declaration

var projectedValue: Published<Value>.Publisher { mutating get set }

The property for which this instance exposes a publisher. The ``Published/projectedValue`` is the property accessed with the `$` operator.

Skipped declarations

657 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

Optional.publisher

The containing type is outside the generated SDK type index.

Optional.Publisher.output

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.init(_:)

The iOS SDK compiler rejected this binding: module 'Combine' has no member named 'Optional'

Optional.Publisher.receive(subscriber:)

This declaration needs Swift generic type arguments. (no canonical witness for S)

Optional.Publisher.contains(_:)

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.removeDuplicates()

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.min()

The containing type needs Swift generic type arguments. (no canonical witness for Wrapped)

Optional.Publisher.max()

The containing type needs Swift generic type arguments. (no canonical witness for Wrapped)

Optional.Publisher.allSatisfy(_:)

callback cannot propagate synchronous failure

Optional.Publisher.collect()

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.compactMap(_:)

callback cannot propagate synchronous failure

Optional.Publisher.min(by:)

callback cannot propagate synchronous failure

Optional.Publisher.max(by:)

callback cannot propagate synchronous failure

Optional.Publisher.contains(where:)

callback cannot propagate synchronous failure

Optional.Publisher.count()

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.dropFirst(_:)

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.drop(while:)

callback cannot propagate synchronous failure

Optional.Publisher.first()

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.first(where:)

callback cannot propagate synchronous failure

Optional.Publisher.last()

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.last(where:)

callback cannot propagate synchronous failure

Optional.Publisher.filter(_:)

callback cannot propagate synchronous failure

Optional.Publisher.ignoreOutput()

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.map(_:)

callback cannot propagate synchronous failure

Optional.Publisher.output(at:)

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.output(in:)

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.prefix(_:)

The iOS SDK compiler rejected this binding: no type named 'Optional' in module 'Combine'

Optional.Publisher.prefix(while:)

callback cannot propagate synchronous failure

Optional.Publisher.reduce(_:_:)

callback cannot propagate synchronous failure

Optional.Publisher.removeDuplicates(by:)

callback cannot propagate synchronous failure