tryGetInstanceProps Method
Get the props of a Relationship instance
tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: string | SourceAndTarget): undefined | T
@returns The RelationshipProps or undefined if the relationship is not found.
@note Useful for cases when a relationship may or may not exist and throwing an Error would be overkill.
@see getInstanceProps
| Parameter | Type | Description |
|---|---|---|
| relClassFullName | string | The full class name of the relationship in the form of "schema:class" |
| criteria | string | SourceAndTarget | Either the relationship instanceId or the source and target Ids |
Returns - undefined | T
The RelationshipProps or undefined if the relationship is not found.
Defined in
- core/backend/src/Relationship.ts Line 487
Last Updated: 24 June, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.