Rewrite the API #286

Borewit · 2020-01-02T11:42:58Z

Includes pull requests:

Use tokenizer #262: Initial integration with strtok3
Use tokenizer #262: Use tokenizer
Separate Node.js dependency #265: Separate Node.js dependency
Support aac & mpeg-2 #266: Support aac & mpeg-2
Use tokenizer browser #268: Use tokenizer browser
Fix extensions and mimeTypes TypeScript types #270: Fix extensions and mimeTypes TypeScript types
Stop execution after fileType.stream error #273: Stop execution after fileType.stream error
Fix waiting for ignore to be completed #274: Fix waiting for ignore to be completed
Fix duplicate name using module instance & file-type result. #275: Fix duplicate name using module instance & file-type result.
Make test name more explicit #276: Make test name more explicit
Add Node.js script to analyze single file (tokenizer version) #277: Add Node.js script to analyze single file (tokenizer version)
Fix readonly-sets #278: Fix readonly-sets
Document module function parseTokenizer #279: Document module function parseTokenizer
Update dependency strtok3 to v5.0 #283: Update dependency strtok3 to v5.0

I don't think I can resolve merge conflicts on stream-tokenizer via a PR, I can only create a PR with resolved conflicts to the master.

To resolve conflicts stream-tokenizer the master branch needs to be merged directly onto stream-tokenizer.

…, fromBuffer, fromFile.

Improve sub-type parsing of PNG, matroska & ZIP file types

Remove ID3 header starting at offset 1 fixture.

Sorted function by signature length.

Co-Authored-By: Sindre Sorhus <sindresorhus@gmail.com>

* Fix readme usage example * Fix `extensions` and `mimeTypes` TypeScript types (#270) Co-Authored-By: Sindre Sorhus <sindresorhus@gmail.com> * 12.4.1 * Fix `.m4b` MPEG-4 audio-book detection (#256) * 12.4.2 * Stop execution after `fileType.stream` error (#273) * Update dependency strtok3 to v5.0 Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com> Co-authored-by: Armando Magalhães <armando.mag95@gmail.com>

# Conflicts: # index.d.ts # index.js # index.test-d.ts # readme.md

Borewit · 2020-01-04T10:15:05Z

@sindresorhus can you please merge?
I got a few days left to support the transition if required.

sindresorhus · 2020-01-04T11:55:45Z

Done. Thanks for all your work on this 🙌

sindresorhus · 2020-01-04T11:56:02Z

Would you be interested in being added as a maintainer? No worries if not though.

sindresorhus · 2020-01-04T12:15:39Z

index.d.ts

-	*/
-	readonly minimumBytes: number;
+/**
+	Deprecated: The minimum amount of bytes needed to detect a file type. Currently, it's 4100 bytes, but it can change, so don't hard-code it.


You say it's deprecated here, but it's not marked as such in the readme. What's the plan here for the deprecation process?

sindresorhus · 2020-01-04T12:55:16Z

readme.md

-### fileType.stream(readableStream)
+(async () => {
+	const httpTokenizer = HttpTokenizer.fromUrl(audioTrackUrl, config);
+	await httpTokenizer.init();


This API is awkward. It should really just be:

const httpTokenizer = await HttpTokenizer.fromUrl(audioTrackUrl, config);

Just changed the API: #287

Borewit · 2020-01-04T15:26:53Z

Would you be interested in being added as a maintainer?

Yes I am. Thank you for your cooperation, was a lot work on your end as well.

Borewit · 2020-01-06T08:20:18Z

Can we please release?

sindresorhus · 2020-01-07T08:35:37Z

Yes I am.

Awesome! Added you to the repo now. While you have commit access to master, it's usually best to do PRs. It never hurts to have another set eye look at changes.

sindresorhus · 2020-01-07T08:35:50Z

Can we please release?

Yes, will do.

sindresorhus · 2020-01-07T09:08:38Z

It's out: https://github.com/sindresorhus/file-type/releases/tag/v13.0.0

sindresorhus and others added 24 commits December 20, 2019 14:11

Integrate with strtok3 tokenizer. Update API with methods: fromStream…

4c2f73b

…, fromBuffer, fromFile.

Integrate with strtok3 tokenizer. Update API with methods: fromStream…

76cac47

…, fromBuffer, fromFile.

Start using tokenizer

c2ece23

Improve sub-type parsing of PNG, matroska & ZIP file types

Migrate ASF parser to use tokenizer

6c9f7a0

Migrate ASF level-2 micro-parser to use tokenizer

55cb89c

Migrate ID3/MPEG fromTokenizer().

4311cc2

Remove ID3 header starting at offset 1 fixture.

Move all remaining buffer functions to use tokenizer.

094bace

Sorted function by signature length.

Replace import with require in examples

2998c68

Update TypeScript definitions to tokenized API

428c026

Merge branch 'stream-tokenizer' into use-tokenizer

ca172fc

Use tokenizer (#262)

96671a5

Separate Node.js dependency (#265)

146f872

Fix duplicate name using module instance & file-type result. (#275)

5cc0774

Make test name more explicit (#276)

39d6370

Fix waiting for ignore to be completed (#274)

f59dde9

Fix readonly-sets (#278)

a888eca

Add Node.js script to analyze single file (tokenizer version) (#277)

f5b75cf

Use tokenizer browser (#268)

0277f45

Support aac & mpeg-2 (#266)

321a50f

Tokenizer: fix merge conflicts with master branch (#280)

293c766

Co-Authored-By: Sindre Sorhus <sindresorhus@gmail.com>

Document module function parseTokenizer (#279)

21a8806

Update dependency strtok3 to v5.0 (#283)

b6e6fd2

Merge branch 'master' into tokenizer/merge-master

98b6acc

# Conflicts: # index.d.ts # index.js # index.test-d.ts # readme.md

This was referenced Jan 2, 2020

Stream tokenizer #285

Closed

Update tokenizer example in README to @tokenizer/http v0.5.0 #287

Closed

sindresorhus changed the title ~~Fixed merged conflicts~~ Rewrite the API Jan 4, 2020

sindresorhus merged commit 8f981c3 into sindresorhus:master Jan 4, 2020

sindresorhus reviewed Jan 4, 2020

View reviewed changes

sindresorhus added a commit that referenced this pull request Jan 4, 2020

Clean up #286

e8eea10

Borewit mentioned this pull request Jan 4, 2020

.aac is detected as .mp4 (audio/mpeg) #259

Closed

Borewit deleted the tokenizer/merge-master branch January 4, 2020 16:16

Borewit mentioned this pull request Jan 4, 2020

Add unit tests with non-MP3 files with prefixing ID3v2 headers #289

Merged

Borewit mentioned this pull request Feb 9, 2020

minimumBytes was not properly deprecated, breaking change #328

Closed

Borewit mentioned this pull request Sep 3, 2021

Ability to detect audio WebM #271

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rewrite the API #286

Rewrite the API #286

Borewit commented Jan 2, 2020 •

edited

Borewit commented Jan 4, 2020

sindresorhus commented Jan 4, 2020

sindresorhus commented Jan 4, 2020

sindresorhus Jan 4, 2020 •

edited

sindresorhus Jan 4, 2020

Borewit Jan 4, 2020

Borewit commented Jan 4, 2020

Borewit commented Jan 6, 2020

sindresorhus commented Jan 7, 2020

sindresorhus commented Jan 7, 2020

sindresorhus commented Jan 7, 2020

Rewrite the API #286

Rewrite the API #286

Conversation

Borewit commented Jan 2, 2020 • edited

Borewit commented Jan 4, 2020

sindresorhus commented Jan 4, 2020

sindresorhus commented Jan 4, 2020

sindresorhus Jan 4, 2020 • edited

Choose a reason for hiding this comment

sindresorhus Jan 4, 2020

Choose a reason for hiding this comment

Borewit Jan 4, 2020

Choose a reason for hiding this comment

Borewit commented Jan 4, 2020

Borewit commented Jan 6, 2020

sindresorhus commented Jan 7, 2020

sindresorhus commented Jan 7, 2020

sindresorhus commented Jan 7, 2020

Borewit commented Jan 2, 2020 •

edited

sindresorhus Jan 4, 2020 •

edited