All files types.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/**
 * Copyright (c) OpenLens Authors. All rights reserved.
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */

import type { Injectable } from "@ogre-tools/injectable";
import type { SingleOrMany } from "@k8slens/utilities";

export type Run<Param> = (parameter: Param) => Promise<void> | void;

export interface Runnable<T = void> {
  id?: never;
  run: Run<T>;
  readonly runAfter?: SingleOrMany<Injectable<Runnable<T>, Runnable<T>, void>>;
}

export interface RunnableWithId<T> {
  run: Run<T>;
  readonly id: string;
  readonly runAfter: RunnableWithId<T>[];
}

export interface RunnableSync<T = void> {
  id?: never;
  run: RunSync<T>;
  runAfter?: SingleOrMany<Injectable<RunnableSync<T>, RunnableSync<T>, void>>;
}

export interface RunnableSyncWithId<T> {
  run: RunSync<T>;
  readonly id: string;
  readonly runAfter: RunnableSyncWithId<T>[];
}

/**
 * NOTE: this is the worse of two evils. This makes sure that `RunnableSync` always is sync.
 * If the return type is `void` instead then async functions (those return `Promise<T>`) can
 * coerce to it.
 */
export type RunSync<Param> = (parameter: Param) => undefined;