Rename the ITransformer.close() method to dispose()

Author: cedx

src/FastTransformer.ts

@@ -37,14 +37,14 @@ export class FastTransformer implements ITransformer {
 	 * @returns Resolves when this object is finally disposed.
 	 */
 	[Symbol.asyncDispose](): Promise<void> {
-		return this.close();
+		return this.dispose();
 	}
 
 	/**
-	 * Closes this transformer.
-	 * @returns Resolves when the transformer has been closed.
+	 * Releases any resources associated with this object.
+	 * @returns Resolves when this object has been disposed.
 	 */
-	close(): Promise<void> {
+	dispose(): Promise<void> {
 		this.#process?.kill();
 		this.#process = null;
 		return Promise.resolve();

src/GulpPlugin.ts

@@ -34,8 +34,8 @@ export class GulpPlugin extends Transform {
 		this.#quiet = options.quiet ?? false;
 		this.#transformer = (options.mode ?? TransformMode.Safe) == TransformMode.Fast ? new FastTransformer(binary) : new SafeTransformer(binary);
 
-		const close = async (): Promise<void> => { await this.#transformer.close(); };
-		this.on("end", close).on("error", close); // eslint-disable-line @typescript-eslint/no-misused-promises
+		const dispose = async (): Promise<void> => { await this.#transformer.dispose(); };
+		this.on("end", dispose).on("error", dispose); // eslint-disable-line @typescript-eslint/no-misused-promises
 	}
 
 	/**

src/ITransformer.ts

@@ -4,10 +4,10 @@
 export interface ITransformer extends AsyncDisposable {
 
 	/**
-	 * Closes this transformer.
-	 * @returns Resolves when the transformer has been closed.
+	 * Releases any resources associated with this object.
+	 * @returns Resolves when this object has been disposed.
 	 */
-	close: () => Promise<void>;
+	dispose: () => Promise<void>;
 
 	/**
 	 * Processes a PHP script.

src/SafeTransformer.ts

@@ -31,14 +31,14 @@ export class SafeTransformer implements ITransformer {
 	 * @returns Resolves when this object is finally disposed.
 	 */
 	[Symbol.asyncDispose](): Promise<void> {
-		return this.close();
+		return this.dispose();
 	}
 
 	/**
-	 * Closes this transformer.
-	 * @returns Resolves when the transformer has been closed.
+	 * Releases any resources associated with this object.
+	 * @returns Resolves when this object has been disposed.
 	 */
-	close(): Promise<void> {
+	dispose(): Promise<void> {
 		return Promise.resolve();
 	}
 

test/FastTransformer.Tests.js

@@ -6,12 +6,12 @@ import {after, describe, it} from "node:test";
  * Tests the features of the {@link FastTransformer} class.
  */
 describe("FastTransformer", () => {
-	describe("close()", () => {
+	describe("dispose()", () => {
 		it("should not reject, even if called several times", async () => {
 			const transformer = new FastTransformer;
 			await doesNotReject(transformer.listen());
-			await doesNotReject(transformer.close());
-			await doesNotReject(transformer.close());
+			await doesNotReject(transformer.dispose());
+			await doesNotReject(transformer.dispose());
 		});
 	});
 
@@ -32,7 +32,7 @@ describe("FastTransformer", () => {
 		]);
 
 		const transformer = new FastTransformer;
-		after(() => transformer.close());
+		after(() => transformer.dispose());
 
 		for (const [key, value] of map) it(key, async () => {
       const output = await transformer.transform("res/Sample.php");

test/SafeTransformer.Tests.js

@@ -6,11 +6,11 @@ import {after, describe, it} from "node:test";
  * Tests the features of the {@link SafeTransformer} class.
  */
 describe("SafeTransformer", () => {
-	describe("close()", () => {
+	describe("dispose()", () => {
 		it("should not reject, even if called several times", async () => {
 			const transformer = new SafeTransformer;
-			await doesNotReject(transformer.close());
-			await doesNotReject(transformer.close());
+			await doesNotReject(transformer.dispose());
+			await doesNotReject(transformer.dispose());
 		});
 	});
 
@@ -23,7 +23,7 @@ describe("SafeTransformer", () => {
 		]);
 
 		const transformer = new SafeTransformer;
-		after(() => transformer.close());
+		after(() => transformer.dispose());
 
 		for (const [key, value] of map) it(key, async () => {
       const output = await transformer.transform("res/Sample.php");