wardens/src/utility-types.ts

A framework for resource management

/* eslint-disable @typescript-eslint/no-explicit-any */
import type ResourceControls from './resource-controls';

/**
 * Represents an arbitrary stateful resource that is asynchronously provisioned
 * and destroyed. Resources can own other resources, and destroying a parent
 * first tears down the children.
 */
export interface ResourceFactory<Value extends object> {
  (resource: ResourceControls): Promise<Resource<Value>>;
}

export interface ParametrizedResourceFactory<
  Value extends object,
  Args extends Array<unknown>,
> {
  (resource: ResourceControls, ...args: Args): Promise<Resource<Value>>;
}

export interface Resource<Value extends object> {
  /** The resource value returned by `create(...)`. */
  value: Value;

  /** A hook that gets called when the resource is destroyed. */
  destroy?(): Promise<unknown> | unknown;
}

/** The `value` type returned when creating a resource. */
export type ResourceHandle<
  Factory extends ParametrizedResourceFactory<object, Array<any>>,
> = Awaited<ReturnType<Factory>>['value'];