From 6d933bff036e1d4a71aeb3f82d62c881e3251dae Mon Sep 17 00:00:00 2001 From: Jaeeun Lee Date: Sun, 18 Jun 2023 15:23:15 -0400 Subject: [PATCH] Remove T prefix from type names after declaring interface Signed-off-by: Jaeeun Lee --- .../README.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/plugins/catalog-backend-module-incremental-ingestion/README.md b/plugins/catalog-backend-module-incremental-ingestion/README.md index 3ba32c454a..6ba3e7c3ca 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/README.md +++ b/plugins/catalog-backend-module-incremental-ingestion/README.md @@ -175,17 +175,17 @@ import { IncrementalEntityProvider } from '@backstage/plugin-catalog-backend-mod // This will include your pagination information, let's say our API accepts a `page` parameter. // In this case, the cursor will include `page` -interface TCursor { +interface Cursor { page: number; } // This interface describes the type of data that will be passed to your burst function. -interface TContext { +interface Context { apiClient: MyApiClient; } export class MyIncrementalEntityProvider - implements IncrementalEntityProvider + implements IncrementalEntityProvider { getProviderName() { return `MyIncrementalEntityProvider`; @@ -197,13 +197,13 @@ export class MyIncrementalEntityProvider ```ts export class MyIncrementalEntityProvider - implements IncrementalEntityProvider + implements IncrementalEntityProvider { getProviderName() { return `MyIncrementalEntityProvider`; } - async around(burst: (context: TContext) => Promise): Promise { + async around(burst: (context: Context) => Promise): Promise { const apiClient = new MyApiClient(); await burst({ apiClient }); @@ -217,7 +217,7 @@ If you need to pass a token to your API, then you can create a constructor that ```ts export class MyIncrementalEntityProvider - implements IncrementalEntityProvider + implements IncrementalEntityProvider { token: string; @@ -229,7 +229,7 @@ export class MyIncrementalEntityProvider return `MyIncrementalEntityProvider`; } - async around(burst: (context: TContext) => Promise): Promise { + async around(burst: (context: Context) => Promise): Promise { const apiClient = new MyApiClient(this.token); await burst({ apiClient }); @@ -240,7 +240,7 @@ export class MyIncrementalEntityProvider The last step is to implement the actual `next` method that will accept the cursor, call the API, process the result and return the result. ```ts -export class MyIncrementalEntityProvider implements IncrementalEntityProvider { +export class MyIncrementalEntityProvider implements IncrementalEntityProvider { token: string; @@ -253,14 +253,14 @@ export class MyIncrementalEntityProvider implements IncrementalEntityProvider Promise): Promise { + async around(burst: (context: Context) => Promise): Promise { const apiClient = new MyApiClient(this.token) await burst({ apiClient }) } - async next(context: TContext, cursor?: TCursor = { page: 1 }): Promise> { + async next(context: Context, cursor?: Cursor = { page: 1 }): Promise> { const { apiClient } = context; // call your API with the current cursor