graphology-operators/subgraph.d.ts

Miscellaneous operators for graphology.

import Graph, {Attributes} from 'graphology-types';

type SubGraphFilter<NodeAttributes extends Attributes = Attributes> = (
  key: string,
  attributes: NodeAttributes
) => boolean;

type SubGraphNodes<NodeAttributes extends Attributes = Attributes> =
  | Array<string>
  | Set<string>
  | SubGraphFilter<NodeAttributes>;

export default function subgraph<
  NodeAttributes extends Attributes = Attributes,
  EdgeAttributes extends Attributes = Attributes,
  GraphAttributes extends Attributes = Attributes
>(
  graph: Graph<NodeAttributes, EdgeAttributes, GraphAttributes>,
  nodes: SubGraphNodes<NodeAttributes>
): Graph<NodeAttributes, EdgeAttributes, GraphAttributes>;