IReferencesService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
export interface IReferencesService
Methods
Method | Description |
|---|---|
(ALPHA) Returns the references between all objects of the workspace. | |
(ALPHA) |
Method details
IReferencesService.getAllReferences()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns the references between all objects of the workspace.
getAllReferences(): Promise<IReferencesResult>;
Returns
Promise<IReferencesResult>
Remarks
Each edge goes from the object that uses another object to the object that it uses. The result has no root nodes.
IReferencesService.getReferences()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
getReferences(root: IdentifierRef | IdentifierRef[], opts?: IReferencesOption): Promise<IReferencesResult>;
Parameters
Parameter | Type | Description |
|---|---|---|
root | ||
opts | (Optional) |
Returns
Promise<IReferencesResult>