Merge pull request #6076 from backstage/rugvip/allreports
scripts/api-extractor: create and check API reports for all(most) plugins
This commit is contained in:
@@ -0,0 +1,56 @@
|
||||
## API Report File for "@backstage/plugin-shortcuts"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
import { ApiRef } from '@backstage/core';
|
||||
import { BackstagePlugin } from '@backstage/core';
|
||||
import { Observable } from '@backstage/core';
|
||||
import ObservableImpl from 'zen-observable';
|
||||
import { StorageApi } from '@backstage/core';
|
||||
|
||||
// @public
|
||||
export class LocalStoredShortcuts implements ShortcutApi {
|
||||
constructor(storageApi: StorageApi);
|
||||
// (undocumented)
|
||||
add(shortcut: Omit<Shortcut, 'id'>): Promise<void>;
|
||||
// (undocumented)
|
||||
getColor(url: string): string;
|
||||
// (undocumented)
|
||||
remove(id: string): Promise<void>;
|
||||
// (undocumented)
|
||||
shortcut$(): ObservableImpl<Shortcut[]>;
|
||||
// (undocumented)
|
||||
update(shortcut: Shortcut): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export type Shortcut = {
|
||||
id: string;
|
||||
url: string;
|
||||
title: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export interface ShortcutApi {
|
||||
add(shortcut: Omit<Shortcut, 'id'>): Promise<void>;
|
||||
getColor(url: string): string;
|
||||
remove(id: string): Promise<void>;
|
||||
shortcut$(): Observable<Shortcut[]>;
|
||||
update(shortcut: Shortcut): Promise<void>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const Shortcuts: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const shortcutsApiRef: ApiRef<ShortcutApi>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const shortcutsPlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
Reference in New Issue
Block a user