Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/scottbedard/pathfinder

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/scottbedard/pathfinder
Owner: scottbedard
License: mit
Created: 2024-05-19T21:23:15.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-05-22T16:11:43.000Z (8 months ago)
Last Synced: 2024-09-25T15:24:17.054Z (3 months ago)
Language: TypeScript
Size: 128 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # `@bedard/pathfinder`

[![Build status](https://img.shields.io/github/actions/workflow/status/scottbedard/pathfinder/test.yml?branch=main&style=flat-square)](https://github.com/scottbedard/pathfinder/actions)

[![Codecov](https://img.shields.io/codecov/c/github/scottbedard/pathfinder?token=3Zz8qEA57I&style=flat-square)](https://codecov.io/gh/scottbedard/pathfinder)

[![NPM](https://img.shields.io/npm/v/%40bedard%2Fpathfinder?style=flat-square)](https://www.npmjs.com/package/@bedard/pathfinder)

[![Bundle size](https://img.shields.io/bundlephobia/minzip/@bedard/pathfinder?label=gzipped&style=flat-square)](https://bundlephobia.com/result?p=@bedard/pathfinder)

[![License](https://img.shields.io/github/license/scottbedard/pathfinder?color=blue&style=flat-square)](https://github.com/scottbedard/pathfinder/blob/main/LICENSE)

This project is a simple javascript implementation of the A* search algorithm. It was mainly built to get my feet wet with Solid.js.

[View sandbox →](https://pathfinder.scottbedard.net)



  



## Basic usage

Use `findPath` to find the shortest path between two points within a two-dimensional matrix.

```ts

import { findPath } from '@bedard/pathfinder'

const maze = [

  [0, 0, 0, 0, 0],

  [1, 1, 1, 1, 0],

  [0, 0, 0, 0, 0],

  [0, 1, 1, 1, 1],

  [0, 0, 0, 0, 0],

]

const solution = findPath({

  data: maze,

  from: { row: 0, col: 0 },

  to: { row: 4, col: 4 },

})

console.log(solution) // [{ row, col }, ...]

```

To optimize the solution, an optional heuristic function can be used. Included with this library are [`euclidean`](https://en.wikipedia.org/wiki/Euclidean_distance) and [`manhattan`](https://en.wikipedia.org/wiki/Taxicab_geometry) distance helpers. When no `heuristic` function is defined, it will use [Dijkstra's algorithm](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm).

```ts

import { euclidean, findPath } from '@bedard/pathfinder'

findPath({

  data,

  from,

  to,

  heuristic: (current, next) => euclidean(next, to), // <- prefer steps towards the target

})

```

## License

[MIT](https://github.com/scottbedard/pathfinder/tree/main?tab=MIT-1-ov-file#readme)

Copyright (c) 2024-present, Scott Bedard