Skip to Content

isEdge()

Source on GitHub 

Test whether an object is usable as an Edge. In TypeScript this is a type guard that will narrow the type of whatever you pass in to Edge if it returns true.

import { isEdge } from '@xyflow/react'; const edge = { id: 'edge-a', source: 'a', target: 'b', }; if (isEdge(edge)) { // ... }

Signature

Parameters:
NameTypeDefault
elementunknown

The element to test

Returns:
boolean
Last updated on