chore: added some more deprecations and fixing some more of the api-report

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2022-02-18 16:22:18 +01:00
parent e21755c639
commit 756f6cc5ef
4 changed files with 12 additions and 8 deletions
+3 -5
View File
@@ -365,9 +365,7 @@ export class DatabaseTaskStore implements TaskStore {
// @public @deprecated
export type DispatchResult = TaskBrokerDispatchResult;
// Warning: (ae-missing-release-tag) "fetchContents" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
// @public
export function fetchContents({
reader,
integrations,
@@ -378,7 +376,7 @@ export function fetchContents({
reader: UrlReader;
integrations: ScmIntegrations;
baseUrl?: string;
fetchUrl?: JsonValue;
fetchUrl?: string;
outputPath: string;
}): Promise<void>;
@@ -496,7 +494,7 @@ export interface TaskBroker {
unsubscribe: () => void;
};
// (undocumented)
vacuumTasks(timeoutS: { timeoutS: number }): Promise<void>;
vacuumTasks(options: { timeoutS: number }): Promise<void>;
}
// @public
@@ -20,6 +20,12 @@ import { ScmIntegrations } from '@backstage/integration';
import fs from 'fs-extra';
import path from 'path';
/**
* A helper function that reads the contents of a directory from the given URL.
* Can be used in your own actions, and also used behind fetch:template and fetch:plain
*
* @public
*/
export async function fetchContents({
reader,
integrations,
@@ -207,8 +207,8 @@ export class StorageTaskBroker implements TaskBroker {
return { unsubscribe };
}
async vacuumTasks(timeoutS: { timeoutS: number }): Promise<void> {
const { tasks } = await this.storage.listStaleTasks(timeoutS);
async vacuumTasks(options: { timeoutS: number }): Promise<void> {
const { tasks } = await this.storage.listStaleTasks(options);
await Promise.all(
tasks.map(async task => {
try {
@@ -161,7 +161,7 @@ export interface TaskBroker {
dispatch(
options: TaskBrokerDispatchOptions,
): Promise<TaskBrokerDispatchResult>;
vacuumTasks(timeoutS: { timeoutS: number }): Promise<void>;
vacuumTasks(options: { timeoutS: number }): Promise<void>;
observe(
options: {
taskId: string;