https://github.com/chouzar/chip

Registry library for gleam
https://github.com/chouzar/chip

Last synced: 4 days ago
JSON representation

Registry library for gleam

• Host: GitHub
• URL: https://github.com/chouzar/chip
• Owner: chouzar
• Created: 2023-11-01T09:26:16.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-30T01:29:38.000Z (13 days ago)
• Last Synced: 2024-11-30T14:55:29.871Z (12 days ago)
• Language: Gleam
• Size: 132 KB
• Stars: 15
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-gleam - chip - [📚](https://hexdocs.pm/chip/) - A Gleam registry library (Packages / Erlang and OTP)

README

        
# Chip - A subject registry for Gleam

[![Package Version](https://img.shields.io/hexpm/v/chip)](https://hex.pm/packages/chip)

[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/chip/)

Chip enables you to register a set of

[subjects](https://hexdocs.pm/gleam_erlang/gleam/erlang/process.html#Subject)

as part of a group.

## Example

We can categorize subjects in groups, then send messages to them:

```gleam

import artifacts/game.{DrawCard, FireDice, PlayChip}

import chip

import gleam/list

pub type Group {

  GroupA

  GroupB

}

pub fn main() {

  let assert Ok(registry) = chip.start(chip.Unnamed)

  let assert Ok(session_a) = game.start(DrawCard)

  let assert Ok(session_b) = game.start(FireDice)

  let assert Ok(session_c) = game.start(PlayChip)

  chip.register(registry, GroupA, session_a)

  chip.register(registry, GroupB, session_b)

  chip.register(registry, GroupA, session_c)

  chip.members(registry, GroupA, 50)

  |> list.each(fn(session) { game.next(session) })

}

```

For more check the [docs and guildelines](https://hexdocs.pm/chip/).

## Development

New additions to the API will be considered with care. Features are

[documented as Issues](https://github.com/chouzar/chip/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement)

on the project's repo, if you have questions or like to see a new feature please open an issue.

For benchmarks run:

```bash

gleam run --module benchmark

```

### Previous Art

This registry takes and combines some ideas from:

* Elixir’s [registry](https://hexdocs.pm/elixir/Kernel.html) module.

* Erlang's [pg](https://www.erlang.org/doc/apps/kernel/pg.html) module.

* The [syn](https://github.com/ostinelli/syn) global registry library.

### Other Gleam registry libraries

Other registry libraries will provide different semantics and functionality:

* [Singularity](https://hexdocs.pm/singularity/) is designed to register a fixed number of actors, each of which may have a different message type.

## Installation

```sh

gleam add chip

```