API Reference

fromGitHook()

Poll a Git repository for new commits and emit commit-shaped graph events.

Import

import { fromGitHook } from "@graphrefly/ts/sources/node";

Signature

function fromGitHook(
	repoPath: string,
	opts: FromGitHookOptions = {},
): Operator<never, GitEvent>

Parameters

Parameter	Type	Description
`repoPath`	`string`	Path to the Git repository to poll.
`opts`	`FromGitHookOptions`	Poll interval, include/exclude file filters, error tolerance, and cancellation signal.

Returns

A node-only source operator that emits GitEvent values after the initial baseline commit.

Example

import { graph } from "@graphrefly/ts/graph";
import { fromGitHook } from "@graphrefly/ts/sources/node";

const g = graph();
const commits = g.initNode(fromGitHook(process.cwd(), { include: ["packages/**"] }), []);

Source

packages/ts/src/sources/node.ts