Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/surfstudio/CoreEvents
Small swift events kit
https://github.com/surfstudio/CoreEvents
Last synced: 3 months ago
JSON representation
Small swift events kit
- Host: GitHub
- URL: https://github.com/surfstudio/CoreEvents
- Owner: surfstudio
- License: mit
- Created: 2018-04-13T07:29:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-05-25T08:40:14.000Z (over 2 years ago)
- Last Synced: 2024-03-15T13:20:21.683Z (8 months ago)
- Language: Swift
- Size: 94.7 KB
- Stars: 6
- Watchers: 36
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - CoreEvents - Simple library with C#-like events. (Reactive Programming / React-Like)
- awesome-ios-star - CoreEvents - Simple library with C#-like events. (Reactive Programming / React-Like)
README
[](https://travis-ci.org/surfstudio/CoreEvents)
[](https://codebeat.co/projects/github-com-surfstudio-coreevents-master)
[](https://codecov.io/gh/surfstudio/CoreEvents/branch/master/graph/badge.svg)
# CoreEvents
Small Swift events kit that provides some base types of events:
- [`FutureEvent`](#futureevent)
- [`PresentEvent`](#presentevent)
- [`PastEvent`](#pastevent)
## FutureEvent
Simple event.
Provides classic behaviour.
### Description
This is classic event (like C# `event`) that can contain many listeners and multicast each new message for this listeners.
This event emits **only** new messages. It means if you add a new listener to existed event then last will not emit previous messages to the new listener.
### Types
- `FutureEvent: Event`
### Example
```swift
var event = FutureEvent()
event += { value in
print("Awesome int: \(value)")
}
event.invoke(with: 42)
```
will print `Awesome int: 42`
## PresentEvent
### Description
This event provides all `Future` logic, but additionally provides emiting last emited value for a new listener.
It means if your event already emits value and you add a new listener then your listener handles previous emited value in the same time.
### Types
- `PresentEvent: Event`
### Example
```swift
var event = PresentEvent()
event += { value in
print("Awesome int: \(value)")
}
event.invoke(with: 42)
event += {
print("Old awesome int: \(value)")
}
```
will print:
`Awesome int: 42`
`Old awesome int: 42`
## PastEvent
### Description
This event is like the Present, but emits all previous messages for a new listener
### Types
- `PastEvent: Event`
### Example
```swift
var event = PastEvent()
event.invoke(with: 0)
event.invoke(with: 1)
event += { value in
print("Awesome int: \(value)")
}
event.invoke(with: 2)
```
Will print:
`Awesome int: 0`
`Awesome int: 1`
`Awesome int: 2`
## How to install
`pod 'CoreEvents', '~> 2.0.1'`
We also support SPM:
`.package(url: "https://github.com/surfstudio/CoreEvents", .exact("2.0.2"))`
## Warning
In one file you can not use just `add`, you should specify a key - `add(key: String, _ listener: Closure)`
## Versioning
Version format is `x.y.z` where
- x is major version number. Bumped only in major updates (implementaion changes, adding new functionality)
- y is minor version number. Bumped only in minor updates (interface changes)
- z is minor version number. Bumped in case of bug fixes and e.t.c.
## Author
[Kravchenkov Alexander](https://github.com/LastSprint)
[MIT License](https://github.com/surfstudio/CoreEvents/blob/master/LICENSE)