index.d.ts

// Type definitions for ngraph.path v1.0.2
// Project: https://github.com/anvaka/ngraph.path
// 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" {


    interface PathFinderOptions<NodeData, LinkData> {
        oriented?: boolean
        quitFast?: boolean
        heuristic?: (from: Node<NodeData>, to: Node<NodeData>) => number
        distance?: (from: Node<NodeData>, to: Node<NodeData>, link: Link<LinkData>) => number
    }

    /** 
     * inlcudeLinks only works for a-star.js 
    */
    interface PathFinder<NodeData> {
        find: (from: NodeId, to: NodeId, includeLinks?:boolean) => Node<NodeData>[]
    }

    export function aStar<NodeData, LinkData>(graph: Graph<NodeData, LinkData>, options?: PathFinderOptions<NodeData, LinkData>): PathFinder<NodeData>

    export function aGreedy<NodeData, LinkData>(graph: Graph<NodeData, LinkData>, options?: PathFinderOptions<NodeData, LinkData>): PathFinder<NodeData>

    export function nba<NodeData, LinkData>(graph: Graph<NodeData, LinkData>, options?: PathFinderOptions<NodeData, LinkData>): PathFinder<NodeData>

}