plugins: generate api reports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-17 11:00:16 +02:00
parent 5429bfa69e
commit d8d7226fce
54 changed files with 5209 additions and 0 deletions
@@ -0,0 +1,98 @@
+## API Report File for "@backstage/plugin-todo-backend"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { CatalogApi } from '@backstage/catalog-client';
+import { Config } from '@backstage/config';
+import { EntityName } from '@backstage/catalog-model';
+import express from 'express';
+import { Logger } from 'winston';
+import { ScmIntegrations } from '@backstage/integration';
+import { UrlReader } from '@backstage/backend-common';
+
+// @public (undocumented)
+export function createRouter(options: RouterOptions): Promise<express.Router>;
+
+// @public (undocumented)
+export function createTodoParser(options?: TodoParserOptions): TodoParser;
+
+// @public (undocumented)
+export type ListTodosRequest = {
+    entity?: EntityName;
+    offset?: number;
+    limit?: number;
+    orderBy?: {
+        field: Fields;
+        direction: 'asc' | 'desc';
+    };
+    filters?: {
+        field: Fields;
+        value: string;
+    }[];
+};
+
+// @public (undocumented)
+export type ListTodosResponse = {
+    items: TodoItem[];
+    totalCount: number;
+    offset: number;
+    limit: number;
+};
+
+// @public (undocumented)
+export type ReadTodosOptions = {
+    url: string;
+};
+
+// @public (undocumented)
+export type ReadTodosResult = {
+    items: TodoItem[];
+};
+
+// @public (undocumented)
+export type TodoItem = {
+    text: string;
+    tag: string;
+    author?: string;
+    viewUrl?: string;
+    lineNumber?: number;
+    repoFilePath?: string;
+};
+
+// @public (undocumented)
+export interface TodoReader {
+    readTodos(options: ReadTodosOptions): Promise<ReadTodosResult>;
+}
+
+// @public (undocumented)
+export class TodoReaderService implements TodoService {
+    constructor(options: Options_2);
+    // (undocumented)
+    listTodos(req: ListTodosRequest, options?: {
+        token?: string;
+    }): Promise<ListTodosResponse>;
+    }
+
+// @public (undocumented)
+export class TodoScmReader implements TodoReader {
+    constructor(options: Options);
+    // (undocumented)
+    static fromConfig(config: Config, options: Omit<Options, 'integrations'>): TodoScmReader;
+    // (undocumented)
+    readTodos({ url }: ReadTodosOptions): Promise<ReadTodosResult>;
+}
+
+// @public (undocumented)
+export interface TodoService {
+    // (undocumented)
+    listTodos(req: ListTodosRequest, options?: {
+        token?: string;
+    }): Promise<ListTodosResponse>;
+}
+
+
+// (No @packageDocumentation comment for this package)
+
+```