Rename types

Author: benjie

__tests__/getTasks.test.ts

@@ -1,8 +1,4 @@
-import {
-  CompiledSharedOptions,
-  WatchedTaskList,
-  WorkerSharedOptions,
-} from "../src";
+import { WorkerSharedOptions } from "../src";
 import { getTasks } from "../src/getTasks";
 import { makeJobHelpers, makeWithPgClientFromClient } from "../src/helpers";
 import { makeEnhancedWithPgClient } from "../src/lib";
@@ -19,10 +15,10 @@ const abortPromise = new Promise<void>((_, reject) => {
 describe("commonjs", () => {
   test("gets tasks from folder", () =>
     withPgClient(async (client) => {
-      const { tasks, release, compiledSharedOptions } = (await getTasks(
+      const { tasks, release, compiledSharedOptions } = await getTasks(
         options,
         `${__dirname}/fixtures/tasks`,
-      )) as WatchedTaskList & { compiledSharedOptions: CompiledSharedOptions };
+      );
       expect(tasks).toBeTruthy();
       expect(Object.keys(tasks).sort()).toMatchInlineSnapshot(`
 Array [
@@ -56,10 +52,10 @@ Array [
 
   test("get tasks from file (vanilla)", () =>
     withPgClient(async (client) => {
-      const { tasks, release, compiledSharedOptions } = (await getTasks(
+      const { tasks, release, compiledSharedOptions } = await getTasks(
         options,
         `${__dirname}/fixtures/tasksFile.js`,
-      )) as WatchedTaskList & { compiledSharedOptions: CompiledSharedOptions };
+      );
       expect(tasks).toBeTruthy();
       expect(Object.keys(tasks).sort()).toMatchInlineSnapshot(`
 Array [
@@ -87,10 +83,10 @@ Array [
 
   test("get tasks from file (vanilla-ts)", () =>
     withPgClient(async (client) => {
-      const { tasks, release, compiledSharedOptions } = (await getTasks(
+      const { tasks, release, compiledSharedOptions } = await getTasks(
         options,
         `${__dirname}/fixtures/tasksFile-ts.js`,
-      )) as WatchedTaskList & { compiledSharedOptions: CompiledSharedOptions };
+      );
       expect(tasks).toBeTruthy();
       expect(Object.keys(tasks).sort()).toMatchInlineSnapshot(`
 Array [
@@ -120,10 +116,10 @@ Array [
 
   test("get tasks from file (default)", () =>
     withPgClient(async (client) => {
-      const { tasks, release, compiledSharedOptions } = (await getTasks(
+      const { tasks, release, compiledSharedOptions } = await getTasks(
         options,
         `${__dirname}/fixtures/tasksFile_default.js`,
-      )) as WatchedTaskList & { compiledSharedOptions: CompiledSharedOptions };
+      );
       expect(tasks).toBeTruthy();
       expect(Object.keys(tasks).sort()).toMatchInlineSnapshot(`
 Array [
@@ -151,10 +147,10 @@ Array [
 
   test("get tasks from file (default-ts)", () =>
     withPgClient(async (client) => {
-      const { tasks, release, compiledSharedOptions } = (await getTasks(
+      const { tasks, release, compiledSharedOptions } = await getTasks(
         options,
         `${__dirname}/fixtures/tasksFile_default-ts.js`,
-      )) as WatchedTaskList & { compiledSharedOptions: CompiledSharedOptions };
+      );
       expect(tasks).toBeTruthy();
       expect(Object.keys(tasks).sort()).toMatchInlineSnapshot(`
 Array [
@@ -184,10 +180,10 @@ Array [
 describe("esm", () => {
   test("gets tasks from folder", () =>
     withPgClient(async (client) => {
-      const { tasks, release, compiledSharedOptions } = (await getTasks(
+      const { tasks, release, compiledSharedOptions } = await getTasks(
         options,
         `${__dirname}/fixtures-esm/tasks`,
-      )) as WatchedTaskList & { compiledSharedOptions: CompiledSharedOptions };
+      );
       expect(tasks).toBeTruthy();
       expect(Object.keys(tasks).sort()).toMatchInlineSnapshot(`
 Array [
@@ -217,10 +213,10 @@ Array [
 
   test("get tasks from file (vanilla)", () =>
     withPgClient(async (client) => {
-      const { tasks, release, compiledSharedOptions } = (await getTasks(
+      const { tasks, release, compiledSharedOptions } = await getTasks(
         options,
         `${__dirname}/fixtures-esm/tasksFile.js`,
-      )) as WatchedTaskList & { compiledSharedOptions: CompiledSharedOptions };
+      );
       expect(tasks).toBeTruthy();
       expect(Object.keys(tasks).sort()).toMatchInlineSnapshot(`
 Array [
@@ -248,10 +244,10 @@ Array [
 
   test("get tasks from file (default)", () =>
     withPgClient(async (client) => {
-      const { tasks, release, compiledSharedOptions } = (await getTasks(
+      const { tasks, release, compiledSharedOptions } = await getTasks(
         options,
         `${__dirname}/fixtures-esm/tasksFile_default.js`,
-      )) as WatchedTaskList & { compiledSharedOptions: CompiledSharedOptions };
+      );
       expect(tasks).toBeTruthy();
       expect(Object.keys(tasks).sort()).toMatchInlineSnapshot(`
 Array [

src/getTasks.ts

@@ -4,8 +4,8 @@ import { join as pathJoin } from "path";
 
 import { tryStat } from "./fs";
 import {
+  InternalWatchedTaskList,
   isValidTask,
-  ReleasableTaskList,
   SharedOptions,
   TaskList,
   WatchedTaskList,
@@ -94,7 +94,7 @@ async function loadFileIntoTasks(
 export async function getTasks(
   options: SharedOptions,
   taskPath: string,
-): Promise<WatchedTaskList> {
+): Promise<InternalWatchedTaskList> {
   const compiledSharedOptions = processSharedOptions(options);
   const result = await getTasksInternal(compiledSharedOptions, taskPath);
   // This assign is used in `__tests__/getTasks.test.ts`
@@ -104,7 +104,7 @@ export async function getTasks(
 export async function getTasksInternal(
   compiledSharedOptions: CompiledSharedOptions,
   taskPath: string,
-): Promise<ReleasableTaskList> {
+): Promise<WatchedTaskList> {
   return await compiledSharedOptions.middleware.run(
     "getTasks",
     {
@@ -121,7 +121,7 @@ export async function getTasksInternal(
 
 async function _getTasksFromFilesystem(
   event: GraphileWorker.GetTasksEvent,
-): Promise<ReleasableTaskList> {
+): Promise<WatchedTaskList> {
   const { ctx: compiledSharedOptions, taskList, taskPath } = event;
 
   const { logger } = compiledSharedOptions;

src/index.ts

@@ -7,11 +7,11 @@ import { getTasks } from "./getTasks";
 import {
   FileDetails,
   PromiseOrDirect,
-  ReleasableTaskList,
   RunOnceOptions,
   SharedOptions,
   Task,
   TaskList,
+  WatchedTaskList,
   WithPgClient,
   Worker,
   WorkerEvents,
@@ -91,7 +91,7 @@ declare global {
 
     interface GetTasksEvent {
       ctx: WorkerPluginContext;
-      taskList: ReleasableTaskList;
+      taskList: WatchedTaskList;
       taskPath: string;
     }
 
@@ -443,7 +443,7 @@ declare global {
        */
       getTasks(
         event: GraphileWorker.GetTasksEvent,
-      ): PromiseOrDirect<ReleasableTaskList>;
+      ): PromiseOrDirect<WatchedTaskList>;
 
       /**
        * Called when performing a graceful shutdown on a WorkerPool.

src/interfaces.ts

@@ -314,11 +314,11 @@ export type TaskList = {
       Task<any>;
 };
 
-export interface ReleasableTaskList {
+export interface WatchedTaskList {
   tasks: TaskList;
   release: () => void;
 }
-export interface WatchedTaskList extends ReleasableTaskList {
+export interface InternalWatchedTaskList extends WatchedTaskList {
   /** @internal */
   compiledSharedOptions: CompiledSharedOptions;
 }