relationshipRole()

function relationshipRole(
   predicate, 
   viewerIsSource, 
   custom?): string;

Defined in: relationships.ts:86

How the OTHER person in an edge relates to the contact being viewed.

Parameters

string

the stored edge predicate (e.g. "parent_of")

boolean

true when the viewed contact is the edge's src

user-defined predicates; they win over built-ins so a user can relabel a predicate without forking its slug

string

a short role/relation label for the other person (viewerIsSource -> the object side; else the subject side)