tarant

KO | EN

gitlite — search

#php #java #hacktoberfest #javascript #python #c #csharp #library #dotfiles #ruby #android #nodejs

★ 76 Open GitHub ↗

Reactive, actor based framework that can be used in client and server side.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ![logomakr_7yenvo](https://user-images.githubusercontent.com/3071208/50427408-f7e54a00-086c-11e9-8fb6-43506ad4d454.png)
[![npm](https://img.shields.io/npm/v/tarant.svg)](https://www.npmjs.com/package/tarant)
[![Build Status](https://travis-ci.org/tarantx/tarant.svg?branch=master)](https://travis-ci.org/tarantx/tarant)
[![Coverage Status](https://coveralls.io/repos/github/tarantx/tarant/badge.svg?branch=master)](https://coveralls.io/github/tarantx/tarant?branch=master)
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
![issues Welcome](https://img.shields.io/badge/issues-welcome-brightgreen.svg)
![npm](https://img.shields.io/npm/l/tarant.svg)
![GitHub issues](https://img.shields.io/github/issues/tarantx/tarant.svg)
![GitHub pull requests](https://img.shields.io/github/issues-pr/tarantx/tarant.svg)
![Downloads](https://img.shields.io/npm/dt/tarant.svg)

[![Join Gitter](https://img.shields.io/gitter/room/TechnologyAdvice/Stardust.svg)](https://gitter.im/tarantx/general?utm_source=share-link&utm_medium=link&utm_campaign=share-link)

[Tarant](https://tarant.js.org/) is a TypeScript/JavaScript library for building software using the actor system model.
You can visit the home page for more information and a more complete quick start guide: https://tarant.js.org/

* **Actors are easy to reason about**: An actor is the unit of state and logic of your application.
They are transactional, so you don't need to handle state rollbacks in case of errors.
* **Actors improve performance**: Asynchronous by default, every actor actual communication is non-blocking so slow actors will not block fast actors.
* **Actors are extensible**: As actors are built on top of objects, actor classes can be inherited, 
composed and injected.

## Features

Tarant implements a rich set of features that makes it suitable for building complex applications.

* Actors are reliable because they are transactional. You don't need to bother yourself with error recovery.
* Actors are performant, as they are pull-based and decoupled from other actors lifecycle.
* Actors are easy to debug. All messages come with information about the sender and all the state information is saved
in a time machine, for further debugging and navigation.
* The Actor System has an event bus. Actors can subscribe, publish and request messages from any topic and subscriptions
can be handled at any time.
* The Actor System is highly extensive. You can add your own supervisor and materializers to add new features like
implicit persistence or rendering of actors.

### Showcase
* [Actors support asynchronous messaging](./examples/ping-pong.js) and answering through Promises. Slow actors will not block fast actors.
* [Actors can schedule tasks](./examples/scheduleds.js) for interval or one-shot delayed actions.
* [Actors are safe and can be recovered with a supervisor](./examples/supervisor.js).
* [Actors can subscribe in a topic in a type-safe way](examples/pubsub.js) for extensible communication.

## Quick start

Creating your first actor system is easy and you don't need to understand everything that is happening under the hood.
First you must install the package:

`npm install tarant --save`

Then create your first ActorSystem

```js
let { Actor, ActorSystem } = require('tarant')
let system = ActorSystem.default()
```

And create your actor class:

```js
class Ping extends Actor {
    ping() {
        console.log("PING")
    }
}
```

Then you only need to instantiate your actor and send messages to it:

```js
let myPinger = system.actorOf(Ping, [])
myPinger.ping()
```

The application will continue running and processing messages until you stop the actor system:

```js
system.free()
```
If you run the application you will see the following output:

```
PING
```

## Contribution ![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg) ![Issues Welcome](https://img.shields.io/badge/issues-welcome-brightgreen.svg)

PR and issues are always welcome as a quick way of contributing to the project. Remember to be polite, this is a open source
project and ordinary requirements for PRs and issues are also a requirement.

If you want to be a long-term contributor and participate actively on the design of new features on the project, contact
us! Check the package.json to see who you need to contact.

##### Created my free [logo](https://logomakr.com/43ipOz) at <a href="http://logomakr.com" title="Logo Makr">LogoMakr.com</a>

tarant

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README