ts-automata

KO | EN

gitlite — search

#hacktoberfest #react #ai #golang #rust #docker #nodejs #windows #awesome #cli #kubernetes #vue #ios #open-source

(★ 37)

Automata simulation utility package for FSMs, PDAs, TMs written for/in JS/TS. @zakrok @sandemiroren1

ts-automata Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
<img src="./.github/logo.jpg" height="250">
</p>
<h1 align="center">
TS-Automata
</h1>
<p align="center">
A TypeScript/JavaScript library for managing automata.
<p>
<h6 align="center">

[![NPM Package](https://img.shields.io/npm/v/ts-automata.svg?style=flat)](https://npmjs.org/package/ts-automata "View this project on npm")
![NPM Downloads](https://img.shields.io/npm/d18m/ts-automata)
![GitHub License](https://img.shields.io/github/license/Zakrok09/ts-automata)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9987/badge)](https://www.bestpractices.dev/projects/9987)

</h6>

```shell
npm i ts-automata
```

> **Check out dnbln's Agda package for Automata proofs: [https://dnbln.dev/agdomaton ](https://dnbln.dev/agdomaton)**

## Overview

Currently supported are the Deterministic, Nondeterministic and Generalised nondeterministic finite state automata as
well as nondeterministic push-down automata.

Make use of the provided TSDoc for insight on the methods.

![GitHub Repo stars](https://img.shields.io/github/stars/zakrok09/ts-automata)

## Building and testing

After cloning the repo, you can use:

```shell
npm i            # to insteall dependencies

npm run build    # to build with tsc

npm run test     # to run tests

npm run coverage # to run tests with coverage
```

## Usage

Automata can be created by choosing an alphabet to feed to the Automaton, defining the states of the automaton and
finally the transition function. The code below is an example of creating and running input on a DFA.

```typescript
/* Initialize the DFA */
const dfa = new DFA("ab", "q0", false);

/* Add states to the DFA */
dfa.addState("q1", false);
dfa.addState("q2", true);

/* Define the transition function for each state */
dfa.addEdge("q0", "b", "q0");
dfa.addEdge("q0", "a", "q1");
dfa.addEdge("q1", "a", "q2");
dfa.addEdge("q1", "b", "q0");
dfa.addEdge("q2", "a", "q2");
dfa.addEdge("q2", "b", "q2");

/* Check for validity */
console.log(dfa.isValid());

/* Run strings on the DFA */
dfa.runString("ababababaa"); // true
dfa.runString("aa"); // true
dfa.runString("abb"); // false
```

_Figure 1: The code for the deterministic finite automaton D._
<img width="898" height="626" alt="README-image" src="https://github.com/user-attachments/assets/0b78c354-5991-4d0c-aba1-9606debc476d" />

_Figure 2: Visual representation of D._

This can also be done using the helpful `DFABuilder`:

```typescript
const dfa = new DFABuilder("ab")
    /* Add states to the DFA */
    .withNotFinalStates("q0", "q1")
    .withFinalStates("q2")

/* Define the transition function for each state */
    .withEdges.from("q0")
    .toSelf()
    .over("b")
    .withEdges.from("q0")
    .to("q1")
    .over("a")
    .withEdges.from("q1")
    .to("q2")
    .over("a")
    .withEdges.from("q1")
    .to("q0")
    .over("b")
    .withEdges.from("q2")
    .toSelf()
    .over("ab")
    .getResult();
```

_Figure 3: Creating a DFA using a `DFABuilder`._

ts-automata

ts-automata Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ts-automata

ts-automata Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README