Rename option.signal to option.abortSignal

sindresorhus · Sep 8, 2024 · fa3eff0 · fa3eff0
1 parent 8f4ece5
commit fa3eff0
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/core.d.ts b/core.d.ts
@@ -489,7 +489,7 @@ export function fileTypeStream(webStream: AnyWebReadableStream<Uint8Array>, opti
 export declare class FileTypeParser {
 	detectors: Iterable<Detector>;
 
-	constructor(options?: {customDetectors?: Iterable<Detector>; abortSignal: AbortSignal});
+	constructor(options?: {customDetectors?: Iterable<Detector>; signal: AbortSignal});
 
 	/**
 	Works the same way as {@link fileTypeFromBuffer}, additionally taking into account custom detectors (if any were provided to the constructor).

diff --git a/core.js b/core.js
@@ -59,7 +59,7 @@ export class FileTypeParser {
 	constructor(options) {
 		this.detectors = options?.customDetectors;
 		this.tokenizerOptions = {
-			abortSignal: options?.abortSignal,
+			abortSignal: options?.signal,
 		};
 		this.fromTokenizer = this.fromTokenizer.bind(this);
 		this.fromBuffer = this.fromBuffer.bind(this);

diff --git a/test.js b/test.js
@@ -473,7 +473,7 @@ test('.fileTypeFromStream() method - be able to abort operation', async t => {
 
 	const shortStream = new MyStream();
 	const abortController = new AbortController();
-	const parser = new NodeFileTypeParser({abortSignal: abortController.signal});
+	const parser = new NodeFileTypeParser({signal: abortController.signal});
 	const promiseFileType = parser.fromStream(shortStream);
 	abortController.abort(); // Abort asynchronous operation: reading from shortStream
 	const error = await t.throwsAsync(promiseFileType);