Error [ERR_REQUIRE_ESM]: Must use import to load ES Module #535

MichaelGradek · 2022-03-11T20:29:54Z

I just installed the library onto my TypeScript project and I get the following error:

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /Users/mike/project/node_modules/file-type/index.js
require() of ES modules is not supported.

Any idea why this may be happening?

"file-type": "^17.1.1"

sindresorhus · 2022-03-12T05:10:08Z

Duplicate of #525

Borewit · 2022-03-12T19:53:53Z

To import a ES module from a CommonJs module wiritten in TypeScript, is very tricky.
The import is transpiled to require, that is why you get the error require() of ES modules is not supported.

Have look to this artice How to Correctly Use TypeScript Module Import Syntax and Settings in Various Circumstances, check When a CommonJS module imports an ES Module. (I have to say, I did followed this guidance myself yet).

Or use a quick and dirty workaround:

/**
 * Import 'file-type' ES-Module in CommonJS Node.js module
 */
(async () => {
  const { fileTypeFromFile } = await (eval('import("file-type")') as Promise<typeof import('file-type')>);

  const type = await fileTypeFromFile('fixture.skp');
  console.log(type);
})();

The quick and dirty workaround example can be found in the PR: Borewit/file-type-example#1

If you got a cleaner solution, I like to get your feedback @MichaelGradek.

Luxcium · 2022-03-15T23:51:13Z

I didnt read the error message at first so I tried const fileTypeFromFile = require('file-type'); instead of import { fileTypeFromFile } from 'file-type';

then realized neither are working

❯ ts-node "${PROJECT}/src/utilities/sharp-phash/__sharp-phash-working.ts"
${PROJECT}/src/packages/file-path/getPathWithStats.ts:4
import { FileTypes } from './tools';
                    ^
Error [ERR_REQUIRE_ESM]: require() of ES Module ${PROJECT}/node_modules/file-type/index.js from ${PROJECT}/src/packages/file-path/getPathWithStats.ts not supported.
Instead change the require of index.js in ${PROJECT}/src/packages/file-path/getPathWithStats.ts to a dynamic import() which is available in all CommonJS modules.
    at Object.<anonymous> (${PROJECT}/src/packages/file-path/getPathWithStats.ts:4:21)
    at Module.m._compile (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/index.js:786:29)
    at Object.require.extensions.<computed> [as .ts] (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/index.js:788:16)
    at Object.<anonymous> (${PROJECT}/src/packages/file-path/utils/index.ts:4:26)
    at Module.m._compile (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/index.js:786:29)
    at Object.require.extensions.<computed> [as .ts] (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/index.js:788:16)
    at Object.<anonymous> (${PROJECT}/src/packages/file-path/tools/dirListWithFileType/currentPath.ts:4:17)
    at Module.m._compile (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/index.js:786:29)
    at Object.require.extensions.<computed> [as .ts] (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/index.js:788:16)
    at Object.<anonymous> (${PROJECT}/src/packages/file-path/tools/dirListWithFileType/index.ts:4:21)
    at Module.m._compile (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/index.js:786:29)
    at Object.require.extensions.<computed> [as .ts] (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/index.js:788:16)
    at Object.<anonymous> (${PROJECT}/src/utilities/sharp-phash/__sharp-phash-working.ts:7:31)
    at Module.m._compile (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/index.js:786:29)
    at Object.require.extensions.<computed> [as .ts] (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/index.js:788:16)
    at main (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/bin.js:292:16)
    at Object.<anonymous> (${HOME}/.nvm/versions/node/v17.5.0/lib/node_modules/ts-node/dist/bin.js:405:5) {
  code: 'ERR_REQUIRE_ESM'
}

Luxcium · 2022-03-15T23:54:46Z

and when using the compiled version of the code:

❯ node "/home/luxcium/projects/parallel-mapping/out/src/utilities/sharp-phash/__sharp-phash-working.js"
/home/luxcium/projects/parallel-mapping/out/src/packages/file-path/getPathWithStats.js:4
const file_type_1 = require("file-type");
                    ^

Error [ERR_REQUIRE_ESM]: require() of ES Module /home/luxcium/projects/parallel-mapping/node_modules/file-type/index.js from /home/luxcium/projects/parallel-mapping/out/src/packages/file-path/getPathWithStats.js not supported.
Instead change the require of index.js in /home/luxcium/projects/parallel-mapping/out/src/packages/file-path/getPathWithStats.js to a dynamic import() which is available in all CommonJS modules.
    at Object.<anonymous> (/home/luxcium/projects/parallel-mapping/out/src/packages/file-path/getPathWithStats.js:4:21)
    at Object.<anonymous> (/home/luxcium/projects/parallel-mapping/out/src/packages/file-path/utils/index.js:4:26)
    at Object.<anonymous> (/home/luxcium/projects/parallel-mapping/out/src/packages/file-path/tools/dirListWithFileType/currentPath.js:4:17)
    at Object.<anonymous> (/home/luxcium/projects/parallel-mapping/out/src/packages/file-path/tools/dirListWithFileType/index.js:4:21)
    at Object.<anonymous> (/home/luxcium/projects/parallel-mapping/out/src/utilities/sharp-phash/__sharp-phash-working.js:7:31) {
  code: 'ERR_REQUIRE_ESM'
}

Node.js v17.7.1

my package.json and tsconfig.json are available at the link: github.com/[...]/package.json

Luxcium · 2022-03-16T00:09:41Z

I can not do any of the different methods I am aware of:

getPathWithStats.ts:

Still getting:

Error [ERR_REQUIRE_ESM]: require() of ES Module ${PROJECT}/node_modules/file-type/index.js from ${PROJECT}/src/packages/file-path/getPathWithStats.ts not supported.
Instead change the require of index.js in ${PROJECT}/src/packages/file-path/getPathWithStats.ts to a dynamic import() which is available in all CommonJS modules.
    at ${PROJECT}/src/packages/file-path/getPathWithStats.ts:39:86
    at async ${PROJECT}/src/packages/file-path/getPathWithStats.ts:39:38 {
  code: 'ERR_REQUIRE_ESM'
}

azhengyongqin · 2022-03-17T09:25:48Z

Stupid updates

kkan0615 · 2022-03-19T16:27:59Z

It makes me super annoying!!!!!!

airone01 · 2022-03-22T15:50:52Z

Thanks @Borewit, I'm using your workaround for now, but somehow I keep getting syntax errors from await not being on top, even tough it is, so I have to wrap everything in an async function.
Pain.

Thomas-1985 · 2022-03-27T16:05:21Z

I really want to use your npm in my TypeScript project and tried import and require, none of them seem to work. The error message is
`
Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /my-project/index.js
require() of ES modules is not supported.
require() of /my-project/node_modules/file-type/index.js from /my-project/users.ts is an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which defines all .js files in that package scope as ES modules.
Instead rename index.js to end in .cjs, change the requiring code to use import(), or remove "type": "module" from /my-project/node_modules/file-type/package.json.

at new NodeError (internal/errors.js:322:7)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:1102:13)
at Module.load (internal/modules/cjs/loader.js:950:32)
at Function.Module._load (internal/modules/cjs/loader.js:790:12)
at Module.require (internal/modules/cjs/loader.js:974:19)
at require (internal/modules/cjs/helpers.js:93:18)
at Object.<anonymous> (/my-project/users.ts:44:1)
at Module._compile (internal/modules/cjs/loader.js:1085:14)
at Module.m._compile (/my-project/node_modules/ts-node/src/index.ts:1459:23)
at Module._extensions..js (internal/modules/cjs/loader.js:1114:10) {

code: 'ERR_REQUIRE_ESM'
}
[nodemon] app crashed - waiting for file changes before starting...
`

Please make it so i can use the npm like with every other by using either import or require

dedeard · 2022-04-01T12:02:44Z

hahahha, i like this update.

dedeard · 2022-04-01T12:07:56Z

this makes me happy
npm i [email protected]

So that we can avoid the dynamic import workaround monstrosity (sindresorhus/file-type#535)

netojose · 2022-04-20T16:40:09Z

I had to make the same thing @dedeardiansya told, downgrade.
I'm watching changes on this issue, when be solved, I update the package.

emimarz · 2022-05-18T14:57:26Z

@netojose to which version do you downgrade?

jloehel · 2022-05-18T15:39:40Z

@netojose to which version do you downgrade?

The 17.0.0 is breaking everything. The versions before should work:

...
    "file-type": "^16.5.3",
...

emimarz · 2022-05-18T15:46:39Z

thanks

netojose · 2022-05-18T16:52:14Z

@emimarz , the version @jloehel said: "^16.5.3"

RemyMachado · 2022-05-27T17:13:28Z

Note that the function fileTypeFromFile is named fromFile with the version 16.5.3

const { fromFile } = require('file-type')

sindresorhus · 2022-05-29T05:02:00Z

TypeScript now fully supports ESM: https://devblogs.microsoft.com/typescript/announcing-typescript-4-7/#ecmascript-module-support-in-node-js

prernagp · 2022-06-06T19:29:13Z

This is still not working... have tried multiple things in my loopback project. I really need the latest fix but unable to do so. @sindresorhus @Borewit pls help

T-vK · 2022-07-12T09:31:37Z

Are there any plans to make file-type CommonJS-compatible again?

Are there any maintained alternatives out there that support getting the mime-type from a buffer like FileType.fromBuffer?

vaibhavkumar-sf · 2022-07-15T09:10:08Z

Same issue in LoopBack Project

prernagp · 2022-07-15T09:24:34Z

@T-vK @vaibhavkumar-sf We have managed to use it like this:-

`const {fileTypeFromBuffer} = await (eval('import("file-type")') as Promise<typeof import('file-type')>);

const fileTrueType = await fileTypeFromBuffer(request);`

Using @Borewit example code:- https://github.com/Borewit/file-type-example/pull/1/files

T-vK · 2022-07-15T16:20:18Z

@prernagp Thank you, I had to modify it a bit, but it basically works.

const exampleGifBuffer = Buffer.from("R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==", "base64");

async function main() {
    const { fileTypeFromBuffer } = await import("file-type");
    const type = await fileTypeFromBuffer(exampleGifBuffer);
    console.log(type);
}

main().catch(console.error);

$ node index.js 
{ ext: 'gif', mime: 'image/gif' }

The only issue is that I can't use await at the top-level...

Edit:
Well, since fileTypeFromBuffer is async anyway, I might as well do it like this:

const exampleGifBuffer = Buffer.from("R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==", "base64");
const fileTypeFromBuffer = async buf =>  {
    fileTypeFromBuffer._cached = fileTypeFromBuffer._cached || (await import("file-type")).fileTypeFromBuffer
    return fileTypeFromBuffer._cached(buf)
}

async function main() {
    const type = await fileTypeFromBuffer(exampleGifBuffer);
    console.log(type);
}

main().catch(console.error);

It makes sure the import is only called once.

vtereshyn · 2022-09-08T09:24:43Z

@netojose to which version do you downgrade?

The 17.0.0 is breaking everything. The versions before should work:
...
    "file-type": "^16.5.3",
...

this version has an audit issue.

netojose · 2022-09-08T12:29:30Z

@vtereshyn , thanks for share this security information. So, we need to choose between the both options (make necessary changes to project to became full ESM, or accept the security issue :( )

vtereshyn · 2022-09-08T12:31:15Z

@vtereshyn , thanks for share this security information. So, we need to choose between the both options (make necessary changes to project to became full ESM, or accept the security issue :( )

Yes. But I have huge project written in Typescript and I don't have an ability to change everything just now. That's why I am working on fork of this repo so I can use commonjs

Borewit · 2022-09-09T17:49:27Z

or accept the security issue :( )

No need for that, that has been addressed in version v16.5.4 @netojose.

cheng-alvin · 2023-01-04T07:52:06Z

"file-type": "^16.5.3",

That's it! Thanks!
Just a side note if you are importing 'fileTypeFromBuffer' (For determining type in v1.18) just modify it to 'fromBuffer'.
Otherwise, it will not compile as it is not featured in 'v1.16.x'

nkemcels · 2023-01-11T15:58:09Z

Downgrade to version 16
yarn add file-type@16

berenar · 2023-08-30T08:52:36Z

My two cents here, upgrading to yarn 3 worked for me!

soydev019 · 2024-04-22T11:47:07Z

I have the same issue, had to downgrade to v16.5.4 to make it work

Shandur · 2024-07-23T15:33:26Z

Thanks to @Borewit - it helped 🙌

max-degterev · 2024-09-02T20:22:48Z

Did anyone fork this package with prober build step already?

sindresorhus marked this as a duplicate of #525 Mar 12, 2022

sindresorhus closed this as completed Mar 12, 2022

Borewit added the question label Mar 12, 2022

Borewit self-assigned this Mar 12, 2022

Borewit reopened this Mar 12, 2022

bmaupin added a commit to bmaupin/resx-extractor that referenced this issue Apr 6, 2022

refactor: Downgrade file-type

6cc1d25

So that we can avoid the dynamic import workaround monstrosity (sindresorhus/file-type#535)

Borewit mentioned this issue Jul 29, 2022

Cannot find module 'strtok3/core' from 'node_modules/file-type/core.js' #548

Closed

Borewit closed this as completed Jul 29, 2022

ollyde mentioned this issue Sep 21, 2022

CommonJS and ESM - support both #556

Closed

julianpoemp mentioned this issue Sep 25, 2022

FormReader reads wrong mimetype from stream dmitriy-nz/nestjs-form-data#37

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module #535

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module #535

MichaelGradek commented Mar 11, 2022

sindresorhus commented Mar 12, 2022

Borewit commented Mar 12, 2022 •

edited

Loading

Luxcium commented Mar 15, 2022 •

edited

Loading

Luxcium commented Mar 15, 2022 •

edited

Loading

Luxcium commented Mar 16, 2022 •

edited

Loading

azhengyongqin commented Mar 17, 2022

kkan0615 commented Mar 19, 2022

airone01 commented Mar 22, 2022

Thomas-1985 commented Mar 27, 2022

dedeard commented Apr 1, 2022

dedeard commented Apr 1, 2022

netojose commented Apr 20, 2022

emimarz commented May 18, 2022

jloehel commented May 18, 2022

emimarz commented May 18, 2022

netojose commented May 18, 2022

RemyMachado commented May 27, 2022

sindresorhus commented May 29, 2022

prernagp commented Jun 6, 2022 •

edited

Loading

T-vK commented Jul 12, 2022 •

edited

Loading

vaibhavkumar-sf commented Jul 15, 2022

prernagp commented Jul 15, 2022 •

edited

Loading

T-vK commented Jul 15, 2022 •

edited

Loading

vtereshyn commented Sep 8, 2022

netojose commented Sep 8, 2022

vtereshyn commented Sep 8, 2022

Borewit commented Sep 9, 2022

cheng-alvin commented Jan 4, 2023 •

edited

Loading

nkemcels commented Jan 11, 2023

berenar commented Aug 30, 2023

soydev019 commented Apr 22, 2024

Shandur commented Jul 23, 2024

max-degterev commented Sep 2, 2024 •

edited

Loading

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module #535

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module #535

Comments

MichaelGradek commented Mar 11, 2022

sindresorhus commented Mar 12, 2022

Borewit commented Mar 12, 2022 • edited Loading

Luxcium commented Mar 15, 2022 • edited Loading

Luxcium commented Mar 15, 2022 • edited Loading

Luxcium commented Mar 16, 2022 • edited Loading

azhengyongqin commented Mar 17, 2022

kkan0615 commented Mar 19, 2022

airone01 commented Mar 22, 2022

Thomas-1985 commented Mar 27, 2022

dedeard commented Apr 1, 2022

dedeard commented Apr 1, 2022

netojose commented Apr 20, 2022

emimarz commented May 18, 2022

jloehel commented May 18, 2022

emimarz commented May 18, 2022

netojose commented May 18, 2022

RemyMachado commented May 27, 2022

sindresorhus commented May 29, 2022

prernagp commented Jun 6, 2022 • edited Loading

T-vK commented Jul 12, 2022 • edited Loading

vaibhavkumar-sf commented Jul 15, 2022

prernagp commented Jul 15, 2022 • edited Loading

T-vK commented Jul 15, 2022 • edited Loading

vtereshyn commented Sep 8, 2022

netojose commented Sep 8, 2022

vtereshyn commented Sep 8, 2022

Borewit commented Sep 9, 2022

cheng-alvin commented Jan 4, 2023 • edited Loading

nkemcels commented Jan 11, 2023

berenar commented Aug 30, 2023

soydev019 commented Apr 22, 2024

Shandur commented Jul 23, 2024

max-degterev commented Sep 2, 2024 • edited Loading

Borewit commented Mar 12, 2022 •

edited

Loading

Luxcium commented Mar 15, 2022 •

edited

Loading

Luxcium commented Mar 15, 2022 •

edited

Loading

Luxcium commented Mar 16, 2022 •

edited

Loading

prernagp commented Jun 6, 2022 •

edited

Loading

T-vK commented Jul 12, 2022 •

edited

Loading

prernagp commented Jul 15, 2022 •

edited

Loading

T-vK commented Jul 15, 2022 •

edited

Loading

cheng-alvin commented Jan 4, 2023 •

edited

Loading

max-degterev commented Sep 2, 2024 •

edited

Loading