Skip to content

@graphty/algorithms / index / WeightUse

Type Alias: WeightUse ​

WeightUse = "never" | "always" | "by-default" | "on-request"

Defined in: catalog.ts:106

Whether an algorithm reads the snapshot's edge weights (its weights column; an unweighted snapshot reads as every weight 1).

  • "never": weights make no difference.
  • "always": it reads them; there is no option to turn that off.
  • "by-default": it reads them unless the options say weighted: false.
  • "on-request": it ignores them unless the options say weighted: true.