core-app-api,app-defaults: API report and doc fixups
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
@@ -5,15 +5,15 @@
|
||||
```ts
|
||||
import { AppComponents } from '@backstage/core-app-api';
|
||||
import { AppIcons } from '@backstage/core-app-api';
|
||||
import { AppManager } from '@backstage/core-app-api/src/app/AppManager';
|
||||
import { AppOptions } from '@backstage/core-app-api';
|
||||
import { AppTheme } from '@backstage/core-plugin-api';
|
||||
import { BackstageApp } from '@backstage/core-app-api';
|
||||
import { IconComponent } from '@backstage/core-plugin-api';
|
||||
|
||||
// @public
|
||||
export function createApp(
|
||||
options?: Omit<AppOptions, keyof OptionalAppOptions> & OptionalAppOptions,
|
||||
): AppManager;
|
||||
): BackstageApp;
|
||||
|
||||
// @public
|
||||
export type OptionalAppOptions = {
|
||||
|
||||
@@ -313,16 +313,11 @@ export type BootErrorPageProps = {
|
||||
|
||||
export { ConfigReader };
|
||||
|
||||
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
|
||||
// Warning: (ae-forgotten-export) The symbol "AppManager" needs to be exported by the entry point index.d.ts
|
||||
//
|
||||
// @public @deprecated
|
||||
export function createApp(options?: OptionalAppOptions): AppManager;
|
||||
export function createApp(options?: OptionalAppOptions): BackstageApp;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "createSpecializedApp" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public
|
||||
export function createSpecializedApp(options: AppOptions): AppManager;
|
||||
export function createSpecializedApp(options: AppOptions): BackstageApp;
|
||||
|
||||
// @public
|
||||
export const defaultConfigLoader: AppConfigLoader;
|
||||
|
||||
@@ -22,7 +22,7 @@ import {
|
||||
/**
|
||||
* Creates a new Backstage App.
|
||||
*
|
||||
* @deprecated Use createApp from @backstage/app-defaults instead
|
||||
* @deprecated Use {@link @backstage/app-defaults#createApp} from `@backstage/app-defaults` instead
|
||||
* @param options - A set of options for creating the app
|
||||
* @public
|
||||
*/
|
||||
|
||||
@@ -20,6 +20,7 @@ import { AppOptions, BackstageApp } from './types';
|
||||
/**
|
||||
* Creates a new Backstage App where the full set of options are required.
|
||||
*
|
||||
* @public
|
||||
* @param options - A set of options for creating the app
|
||||
* @returns
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user