Missing fileTypeOptions for fileTypeFromStream function in index declaration file

[sly7-7]

Description

The options with customDetectors are missing in the declaration file, see:

file-type/index.d.ts

Line 59 in 643ef78

export function fileTypeFromStream(stream: AnyWebReadableStream<Uint8Array> | NodeReadableStream): Promise<FileTypeResult | undefined>;

Existing Issue Check

• I have searched the existing issues and could not find any related to my problem.

ESM (ECMAScript Module) Requirement Acknowledgment

• My project is an ESM project and my package.json contains the following entry: "type": "module".

File-Type Scope Acknowledgment

• I understand that file-type detects binary file types and not text or other formats.

[sly7-7]

Also, I've noted that the exported functions from core.js don't have the detectors in their signatures. Maybe this was on purpose ? In my use case then, I've used straight the FileTypeParser() constructor passing it a detector.
Please let me know if this is the right way, or if you would accept a pr with the detectors available in core.js.

[Borewit]

The options are not missing from the types, the options can only be passed via the constructor. Which may like or not like, but that is not a bug.

My philosophy behind was something like, if you do want to change the default behavior of file-type, you probably do not mind to call the constructor. That way you can also reuse the customized instance, for assessing multiple files.

To me it feels a bit odd if each function passes the options to the constructor. Then we also have repeat the documentation for it. But I also see it may appear a bit more convenient.

[sly7-7]

Thank your for your answer, I understand your philosophy, and if I understand it well, then I'm doing what's intended 😃

One thing though, unless I'm missing something else (which can be very possible 😅 ), there is an inconsistency between index.js where fileTypeOptionsis in the signature

file-type/index.js

Line 72 in 3945d7f

export async function fileTypeFromStream(stream, fileTypeOptions) {

whereas it does not appear in index.d.ts:

file-type/index.d.ts

Line 65 in 3945d7f

export function fileTypeFromStream(stream: AnyWebReadableStream<Uint8Array> | NodeReadableStream): Promise<FileTypeResult | undefined>;

Also I've just noticed an other small thing looking weird to me:

file-type/index.js

Line 69 in 3945d7f

return (new FileTypeParser(fileTypeOptions)).fromFile(path, fileTypeOptions);

fileTypeOptions beeing passed to fromFile(), but

file-type/index.js

Line 20 in 3945d7f

async fromFile(path) {

does not use it.

One more time, maybe I'm totally wrong and I just don't read the code correctly, but if I'm right, I could make a PR to remove these inconsistencies.