https://github.com/nfibrokerage/slipstream

A slick WebSocket client for Phoenix Channels
https://github.com/nfibrokerage/slipstream

phoenix phoenix-channels websocket

Last synced: 2 days ago
JSON representation

A slick WebSocket client for Phoenix Channels

• Host: GitHub
• URL: https://github.com/nfibrokerage/slipstream
• Owner: NFIBrokerage
• License: apache-2.0
• Created: 2021-01-22T21:47:50.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-04T14:08:26.000Z (29 days ago)
• Last Synced: 2024-12-24T00:47:59.026Z (10 days ago)
• Topics: phoenix, phoenix-channels, websocket
• Language: Elixir
• Homepage: https://hex.pm/packages/slipstream
• Size: 462 KB
• Stars: 162
• Watchers: 13
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Slipstream

![CI](https://github.com/NFIBrokerage/slipstream/workflows/CI/badge.svg)

[![Coverage Status](https://coveralls.io/repos/github/NFIBrokerage/slipstream/badge.svg)](https://coveralls.io/github/NFIBrokerage/slipstream)

[![hex.pm version](https://img.shields.io/hexpm/v/slipstream.svg)](https://hex.pm/packages/slipstream)

[![hex.pm license](https://img.shields.io/hexpm/l/slipstream.svg)](https://github.com/NFIBrokerage/slipstream/blob/main/LICENSE)

[![Last Updated](https://img.shields.io/github/last-commit/NFIBrokerage/slipstream.svg)](https://github.com/NFIBrokerage/slipstream/commits/main)

A slick websocket client for Phoenix channels

See the [online documentation](https://hexdocs.pm/slipstream)

## Main Features

- backed by [Mint.WebSocket](https://github.com/NFIBrokerage/mint_web_socket)

- an `await_*` interface for a interacting [synchronously](https://hexdocs.pm/slipstream/Slipstream.html#module-synchronicity)

- built-in [re-connect and re-join mechanisms](https://hexdocs.pm/slipstream/Slipstream.html#module-retry-mechanisms) matching `phoenix.js`

- a [testing framework](https://hexdocs.pm/slipstream/Slipstream.SocketTest.html#content) for clients

- emits [`:telemetry` events](https://hexdocs.pm/slipstream/telemetry.html#content)

## Installation

Add slipstream to your dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:slipstream, "~> 1.0"}

  ]

end

```

> We've been using Slipstream in production for the better part of a year.

> The interface is stable and a v1.0.0 release is imminent!

## Documentation

Documentation is automatically published to

[hexdocs.pm](https://hexdocs.pm/slipstream) on release. You may build the

documentation locally with

```

MIX_ENV=docs mix docs

```

## Contributing

Issues and PRs are very welcome! See our organization

[`CONTRIBUTING.md`](https://github.com/NFIBrokerage/.github/blob/main/CONTRIBUTING.md)

for more information about best-practices and passing CI.

If you're considering sending a PR or otherwise forking Slipstream, you may

wish to read [the implementation docs](guides/implementation.md) first.