https://github.com/canjs/can-bacon
Bacon.js integration for CanJS (and vice-versa)
https://github.com/canjs/can-bacon
Last synced: 7 months ago
JSON representation
Bacon.js integration for CanJS (and vice-versa)
- Host: GitHub
- URL: https://github.com/canjs/can-bacon
- Owner: canjs
- License: mit
- Created: 2014-05-18T11:17:08.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2017-08-15T23:32:50.000Z (almost 9 years ago)
- Last Synced: 2025-04-02T08:35:53.164Z (about 1 year ago)
- Language: JavaScript
- Size: 881 KB
- Stars: 17
- Watchers: 13
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# NOT MAINTAINED! This project is abandoned,
## can.bacon
`can.bacon` is a [CanJS](https://github.com/bitovi/canjs) plugin that lets you
create [Bacon.js](https://github.com/baconjs/bacon.js) `EventStream`s and
`Property`s from `CanJS` event handlers, as well as feed `Bacon` observable
streams back into `CanJS` observables. The result is a delicious,
canned-bacon-flavored mix of
[FRP](https://en.wikipedia.org/wiki/Functional_reactive_programming) and
`CanJS`-style declarative MVC.
`can.bacon` implements the
[can.eventstream](https://github.com/zkat/can.eventstream) interface and
adds a few methods to `Bacon` objects (documented below). For information on the
`CanJS` side of the interface, please refer to `can.eventstream`'s documentation.
Check out `dist/sandbox.html` and `dist/sandbox.js` for some rough usage
examples, including a fairly short drag-and-drop demo using `can.Component`, and
super-simple, single-line two-way binding between pairs of computes and pairs of
`can.Map`s.
`can.bacon` is
[hosted at Github](http://github.com/zkat/can.bacon). `can.bacon` is a
public domain work, dedicated using
[CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/). Feel free to do
whatever you want with it.
# Quickstart
### Install
`$ npm install can.bacon`
or
`$ bower install can.bacon`
Prebuilt releases are included in `dist`. Releases tagged as `full` include
`Bacon`, `jQuery`, and `CanJS` in a single package. The others expect the other
libraries to have already been loaded.
### Example
```javascript
var compute = can.compute(),
property = compute.bind();
property.log("Property has new value:");
compute(1);
property.toCompute().bind("change", function() {
console.log("compute updated from property change.");
});
compute(2);
```
# Documentation
For the most part, `can.bacon` is a straightforward implementation of the
`can.eventstream` interface. For most bindings, it will return a
`Bacon.EventStream` instance. The only exception to this is when bindings are
made to `can.compute` instances, in which case a `Bacon.Property` is returned,
with the current value of the `can.compute` as its initial value.
`can.bacon` also extends `Bacon.Observable.prototype` with a few utility methods
that directly wrap `can.eventstream` functions, documented below.
### `Bacon.Observable#toCompute([compute=can.compute()])`
Wraps `can.bindComputeFromStream`.
`stream.toCompute(compute)` is the same as `can.bindComputeFromStream(stream,
compute);`
### `Bacon.Observable#toMap([map=new can.Map()])`
Wraps `can.bindMapFromStream`.
`stream.toMap(compute)` is the same as `can.bindMapFromStream(stream,
compute);`
### `Bacon.Observable#toList([list=new can.List()])`
Wraps `can.bindListFromStream`.
`stream.toList(compute)` is the same as `can.bindListFromStream(stream,
compute);`