Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use strtok3 ESM module (prerelease) #474

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@ jobs:
- 16
- 14
- 12
- 10
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
- uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- run: npm install
Expand Down
48 changes: 21 additions & 27 deletions browser.d.ts
Original file line number Diff line number Diff line change
@@ -1,50 +1,44 @@
/// <reference lib="dom"/>
import * as core from './core';

export type FileTypeResult = core.FileTypeResult;
export type FileExtension = core.FileExtension;
export type MimeType = core.MimeType;
import {FileTypeResult} from './core.js';

/**
Determine file type from a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream).

```
import FileType = require('file-type/browser');
import FileType from 'file-type/browser';

const url = 'https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg';

(async () => {
const response = await fetch(url);
const fileType = await FileType.fromStream(response.body);
const response = await fetch(url);
const fileType = await FileType.fromStream(response.body);

console.log(fileType);
//=> {ext: 'jpg', mime: 'image/jpeg'}
})();
console.log(fileType);
//=> {ext: 'jpg', mime: 'image/jpeg'}
```
*/
export declare function fromStream(stream: ReadableStream): Promise<core.FileTypeResult | undefined>;
export declare function fromStream(stream: ReadableStream): Promise<FileTypeResult | undefined>;

/**
Determine file type from a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob).

```
import FileType = require('file-type/browser');
import FileType from 'file-type/browser';

(async () => {
const blob = new Blob(['<?xml version="1.0" encoding="ISO-8859-1" ?>'], {
type: 'plain/text',
endings: 'native'
});
const blob = new Blob(['<?xml version="1.0" encoding="ISO-8859-1" ?>'], {
type: 'plain/text',
endings: 'native'
});

console.log(await FileType.fromBlob(blob));
//=> {ext: 'txt', mime: 'plain/text'}
})();
console.log(await FileType.fromBlob(blob));
//=> {ext: 'txt', mime: 'plain/text'}
```
*/
export declare function fromBlob(blob: Blob): Promise<core.FileTypeResult | undefined>;
export declare function fromBlob(blob: Blob): Promise<FileTypeResult | undefined>;

export {
fromBuffer,
extensions,
mimeTypes
} from './core';
supportedExtensions,
supportedMimeTypes,
FileTypeResult,
FileExtension,
MimeType,
} from './core.js';
39 changes: 20 additions & 19 deletions browser.js
Original file line number Diff line number Diff line change
@@ -1,21 +1,9 @@
'use strict';
const {ReadableWebToNodeStream} = require('readable-web-to-node-stream');
const core = require('./core');

async function fromStream(stream) {
const readableWebToNodeStream = new ReadableWebToNodeStream(stream);
const fileType = await core.fromStream(readableWebToNodeStream);
await readableWebToNodeStream.close();
return fileType;
}

async function fromBlob(blob) {
const buffer = await blobToArrayBuffer(blob);
return core.fromBuffer(Buffer.from(buffer));
}
import {ReadableWebToNodeStream} from 'readable-web-to-node-stream';
import {fromBuffer, fromStream as coreFromStream} from './core.js';

/**
Convert Blobs to ArrayBuffer.

@param {Blob} blob - Web API Blob.
@returns {Promise<ArrayBuffer>}
*/
Expand Down Expand Up @@ -43,7 +31,20 @@ function blobToArrayBuffer(blob) {
});
}

Object.assign(module.exports, core, {
fromStream,
fromBlob
});
export async function fromStream(stream) {
const readableWebToNodeStream = new ReadableWebToNodeStream(stream);
const fileType = await coreFromStream(readableWebToNodeStream);
await readableWebToNodeStream.close();
return fileType;
}

export async function fromBlob(blob) {
const buffer = await blobToArrayBuffer(blob);
return fromBuffer(Buffer.from(buffer));
}

export {
fromTokenizer,
fromBuffer,
stream,
} from './core.js';