archive-gh-me/ngraph.path
1
0
Fork 0
mirror of https://github.com/anvaka/ngraph.path.git synced 2026-01-25 15:23:38 +00:00
Code Issues Projects Releases Wiki Activity

feat(Typescript): Add generic data types for strongly typing nodes/links

Browse Source
This commit is contained in:
Zak Henry 2019-05-12 15:15:21 +01:00
parent 6798fc9818
commit 532ab69256
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
index.d.ts vendored
View File

@ -3,25 +3,26 @@
// Definitions by: Nathan Westlake <https://github.com/CorayThan>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
import { Graph, Link, Node, NodeId } from "ngraph.graph"
declare module "ngraph.path" {
import { Graph, Link, Node, NodeId } from "ngraph.graph"
interface PathFinderOptions {
interface PathFinderOptions<NodeData, LinkData> {
oriented?: boolean
quitFast?: boolean
heuristic?: (from: NodeId, to: NodeId) => number
distance?: (from: NodeId, to: NodeId, link: Link) => number
heuristic?: (from: Node<NodeData>, to: Node<NodeData>) => number
distance?: (from: Node<NodeData>, to: Node<NodeData>, link: Link<NodeData>) => number
}
interface PathFinder {
find: (from: NodeId, to: NodeId) => Node[]
interface PathFinder<NodeData> {
find: (from: NodeId, to: NodeId) => Node<NodeData>[]
}
export function aStar(graph: Graph, options?: PathFinderOptions): PathFinder
export function aStar<NodeData, LinkData>(graph: Graph<NodeData, LinkData>, options?: PathFinderOptions<NodeData, LinkData>): PathFinder<NodeData>
export function aGreedy(graph: Graph, options?: PathFinderOptions): PathFinder
export function aGreedy<NodeData, LinkData>(graph: Graph<NodeData, LinkData>, options?: PathFinderOptions<NodeData, LinkData>): PathFinder<NodeData>
export function nba(graph: Graph, options?: PathFinderOptions): PathFinder
export function nba<NodeData, LinkData>(graph: Graph<NodeData, LinkData>, options?: PathFinderOptions<NodeData, LinkData>): PathFinder<NodeData>
}