Interface AppTreeApi

The API for interacting with the AppTree.

interface AppTreeApi {
getNodesByRoutePath(routePath: string): { nodes: AppNode[] };
getTree(): { tree: AppTree };
}

Index

Methods

getNodesByRoutePath getTree

Methods

getNodesByRoutePath

getNodesByRoutePath(routePath: string): { nodes: AppNode[] }
Get all nodes in the app that are mounted at a given route path.
Parameters
- routePath: string
Returns { nodes: AppNode[] }
- Defined in packages/frontend-plugin-api/src/apis/definitions/AppTreeApi.ts:112

getTree

getTree(): { tree: AppTree }
Get the AppTree for the app.

Returns { tree: AppTree }
- Defined in packages/frontend-plugin-api/src/apis/definitions/AppTreeApi.ts:107