Skip to content
Clients (javascript and .NET) that can subscribe real-time updates from a Butterfly.Web server in C#
JavaScript C#
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Butterfly.Client.DotNet
Butterfly.Client.Web
docfx_project
docs
img
.gitattributes
.gitignore
Butterfly.Client.sln
CODE_OF_CONDUCT.md
LICENSE
README.md

README.md

Butterfly.Client Butterfly Logo

Clients (javascript and .NET) that can subscribe real-time updates from a Butterfly.Web server in C#

Install from Source Code

git clone https://github.com/firesharkstudios/butterfly-client

Butterfly.Client.Web

Overview

Butterfly.Client.Web is a plain vanilla javascript library that works with any framework and allows subscribing to channels in a Butterfly.Web server to keep local javascript arrays automatically updated.

The easiest way to install Butterfly Client is with npm...

npm install butterfly-client

You can then include the Butterfly Client with a script import like...

<script src="./node_modules/butterfly-client/lib/butterfly-client.js"></script>

Or include the classes you need with an appropriate ES6 import like...

import { ArrayDataEventHandler, WebSocketChannelClient } from 'butterfly-client'

Example

All the examples at Butterfly.Server use the butterfly-client client to communicate with a Butterfly.Web server.

See these examples to see how butterfly-client allows a web client to automatically keep local javascript arrays synchronized with a server.

Contributing

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

Licensing

The code is licensed under the Mozilla Public License 2.0.

You can’t perform that action at this time.