Skip to content

Commit

Permalink
Update core.d.ts
Browse files Browse the repository at this point in the history
Use hash for class method member reference.
Simplify code comments.

Co-authored-by: Sindre Sorhus <[email protected]>
  • Loading branch information
Borewit and sindresorhus committed Dec 18, 2024
1 parent 64442f9 commit 4b3d9fb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
12 changes: 5 additions & 7 deletions core.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,9 @@ console.log(await fileTypeFromBlob(blob));
export declare function fileTypeFromBlob(blob: Blob): Promise<FileTypeResult | undefined>;

/**
A custom detector is a function that allows specifying custom detection mechanisms.
A custom file type detector.
An array of detectors can be provided via the `fileTypeOptions` argument for the `FileTypeParser` constructor.
In Node.js, you should use `NodeFileTypeParser`, which extends `FileTypeParser` and provides access to Node.js specific functions.
Detectors can be added via the constructor options, or by adding it directly to `FileTypeParser.detectors`.
Detectors can be added via the constructor options, or by adding it directly to `FileTypeParser#detectors`.
The detectors provided via the constructor options, are called before the default detectors are called.
Expand Down Expand Up @@ -184,8 +181,9 @@ export function fileTypeStream(webStream: AnyWebReadableStream<Uint8Array>, opti

export declare class FileTypeParser {
/**
File-type detectors, initialized with a single entry holding the build in detector function.
The array is used to iterate over all detectors, as long as the function returns `undefined`.
File type detectors.
Initialized with a single entry holding the built-in detector function.
*/
detectors: Detector[];

Expand Down
4 changes: 1 addition & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,9 +342,7 @@ Returns a `Set<string>` of supported MIME types.
A custom detector is a function that allows specifying custom detection mechanisms.
An iterable of detectors can be provided via the `fileTypeOptions` argument for the `FileTypeParser` constructor.
Detectors can be added via the constructor options, or by adding it directly to `FileTypeParser.detectors`.
Detectors can be added via the constructor options, or by adding it directly to `FileTypeParser#detectors`.
The detectors provided via the constructor options, are called before the default detectors are called.
Expand Down

0 comments on commit 4b3d9fb

Please sign in to comment.