removed documentation links to the @backstage/core-app-api#createApp
Signed-off-by: Colton Padden <colton.padden@fastmail.com>
This commit is contained in:
@@ -73,7 +73,7 @@ const DefaultErrorBoundaryFallback = ({
|
||||
};
|
||||
|
||||
/**
|
||||
* Creates a set of default components to pass along to {@link @backstage/core-app-api#createApp}.
|
||||
* Creates a set of default components to pass along to {@link @backstage/core-app-api#createSpecializedApp}.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
|
||||
@@ -200,8 +200,6 @@ export type AppIcons = {
|
||||
warning: IconComponent;
|
||||
};
|
||||
|
||||
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-app-api" does not have an export "createApp"
|
||||
//
|
||||
// @public
|
||||
export type AppOptions = {
|
||||
apis?: Iterable<AnyApiFactory>;
|
||||
@@ -223,8 +221,6 @@ export type AppOptions = {
|
||||
bindRoutes?(context: { bind: AppRouteBinder }): void;
|
||||
};
|
||||
|
||||
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-app-api" does not have an export "createApp"
|
||||
//
|
||||
// @public
|
||||
export type AppRouteBinder = <
|
||||
ExternalRoutes extends {
|
||||
@@ -272,8 +268,6 @@ export type AuthApiCreateOptions = {
|
||||
provider?: AuthProviderInfo;
|
||||
};
|
||||
|
||||
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-app-api" does not have an export "createApp"
|
||||
//
|
||||
// @public
|
||||
export type BackstageApp = {
|
||||
getPlugins(): BackstagePlugin<any, any>[];
|
||||
|
||||
@@ -23,6 +23,13 @@ import { AppOptions, BackstageApp } from './types';
|
||||
* @public
|
||||
* @param options - A set of options for creating the app
|
||||
* @returns
|
||||
* @remarks
|
||||
*
|
||||
* You will most likely want to use {@link @backstage/app-defaults#createApp},
|
||||
* however, this low-level API allows you to provide a full set of options,
|
||||
* including your own `components`, `icons`, `defaultApis`, and `themes`. This
|
||||
* is particularly useful if you are not using `@backstage/core-components` or
|
||||
* MUI, as it allows you to avoid those dependencies completely.
|
||||
*/
|
||||
export function createSpecializedApp(options: AppOptions): BackstageApp {
|
||||
return new AppManager(options);
|
||||
|
||||
@@ -189,7 +189,7 @@ type TargetRouteMap<
|
||||
|
||||
/**
|
||||
* A function that can bind from external routes of a given plugin, to concrete
|
||||
* routes of other plugins. See {@link createApp}.
|
||||
* routes of other plugins. See {@link createSpecializedApp}.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
@@ -204,7 +204,7 @@ export type AppRouteBinder = <
|
||||
) => void;
|
||||
|
||||
/**
|
||||
* The options accepted by {@link createApp}.
|
||||
* The options accepted by {@link createSpecializedApp}.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
@@ -306,7 +306,7 @@ export type AppOptions = {
|
||||
};
|
||||
|
||||
/**
|
||||
* The public API of the output of {@link createApp}.
|
||||
* The public API of the output of {@link createSpecializedApp}.
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user