https://github.com/icanzilb/rxtimelane

Timelane + RxSwift
https://github.com/icanzilb/rxtimelane

Last synced: 12 days ago
JSON representation

Timelane + RxSwift

• Host: GitHub
• URL: https://github.com/icanzilb/rxtimelane
• Owner: icanzilb
• License: mit
• Created: 2020-02-28T09:24:00.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-02-19T15:32:43.000Z (over 3 years ago)
• Last Synced: 2024-10-23T06:07:11.809Z (21 days ago)
• Language: Swift
• Homepage: http://timelane.tools
• Size: 456 KB
• Stars: 132
• Watchers: 7
• Forks: 15
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RxTimelane

![Timelane Icon](etc/[email protected])

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

![Timelane Instrument](etc/timelane.png)



    

    

    



#### Contents:

 - [Usage](#Usage)

 - [API Reference](#Reference)

 - [Installation](#Installation)

 - [Demo](#Demo)

 - [License](#License)

# Usage

> **Note:** To observe the output of using TimelaneCombine you need to install the [Timelane Instrument](https://github.com/icanzilb/Timelane/releases/latest) in advance. More information at: [http://timelane.tools](http://timelane.tools).

Import the RxTimelane framework in your code:

```swift

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:

```swift

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](etc/timelane-template.png)

Inspect your subscriptions on the timeline:

![Timelane Live Recording](etc/timelane-recording.gif)

For a more detailed walkthrough go to [http://timelane.tools](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:

```swift

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:

```swift

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

```

## CocoaPods

[CocoaPods](https://cocoapods.org) 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`:

```ruby

pod 'RxTimelane', '~> 2.0'

```

## Carthage

Not supported. [More info](https://github.com/icanzilb/RxTimelane/issues/11)

# 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](etc/demo.png)

# License

Copyright (c) Marin Todorov 2020

This package is provided under the MIT License.