Swiftpack.co - Package - icanzilb/RxTimelane

RxTimelane

Timelane Icon

RxTimelane provides RxSwift bindings for profiling RxSwift code with the Timelane Instrument.

Timelane Instrument

Contents:

Usage

Note: To observe the output of using TimelaneCombine you need to install the Timelane Instrument in advance. More information at: http://timelane.tools.

Import the RxTimelane framework in your code:

import RxTimelane

Use the lane(_) operator to profile a subscription via the TimelaneInstrument. Insert lane(_) at the precise spot in your code you'd like to profile like so:

downloadImage(at: url).
  .lane("Download: \(url.path)")
  .assign(to: \.image, on: myImageView)

Then profile your project by clicking Product > Profile in Xcode's main menu.

Select the Timelane Instrument template:

Timelane Instrument Template

Inspect your subscriptions on the timeline:

Timelane Live Recording

For a more detailed walkthrough go to http://timelane.tools.

API Reference

lane(_:filter:)

Use lane("Lane name") to send data to both the subscriptions and events lanes in the Timelane Instrument.

lane("Lane name", filter: [.subscriptions]) sends begin/completion events to the Subscriptions lane. Use this syntax if you only want to observe concurrent subscriptions.

lane("Lane name", filter: [.events]) sends events and values to the Events lane. Use this filter if you are only interested in values a subscription would emit (e.g. for example subjects).

Additionally you can transform the values logged in Timelane by using the optional transformValue trailing closure:

lane("Lane name", transformValue: { value in
  return "Value: \(value)"
})

Installation

Swift Package Manager

I . Automatically in Xcode:

  • Click File > Swift Packages > Add Package Dependency...
  • Use the package URL https://github.com/icanzilb/RxTimelane to add TimelaneCombine to your project.

II . Manually in your Package.swift file add:

.package(url: "https://github.com/icanzilb/RxTimelane", from: "2.0.0")

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate RxTimelane into your Xcode project using CocoaPods, add it to your Podfile:

pod 'RxTimelane', '~> 2.0'

Carthage

Not supported. More info

Demo

This repo contains a simple demo app. To give it a try open RxTimelaneExample/RxTimelane.xcodeproj and run the "RxTimelaneExample" scheme.

Timelane demo app

License

Copyright (c) Marin Todorov 2020 This package is provided under the MIT License.

Github

link
Stars: 105

Dependencies

Used By

Total: 0

Releases

RxTimelane 2.0.0 -

Improvements + upgrade to protocol 2

RxTimelane 1.0.9 -

Fixes bugs introduced in 1.0.8 and upgrades to TimelaneCore 1.0.10

RxTimelane 1.0.8 -

Fixes a bug with multiple subscriptions to non-shared observables

RxTimelane 1.0.7 -

Removes incomplete Carthage support

RxTimelane 1.0.6 -

Traits support - Maybe, Single, and Completable

RxTimelane 1.0.5 -

RxTimelane 1.0.4 -

Version resolving

RxTimelane 1.0.3 -

Adds Carthage support

RxTimelane 1.0.2 -

Adds Cocoapods support

RxTimelane 1.0.1 -

  • adds a formatting closure to lane()
  • changed availability

RxTimelane 1.0 -

RxTimelane 1.0