TypeError: ncu is not a function

[atomicrobokid]

• I have searched for similar issues
• [x ] I am using the latest version of npm-check-updates
• [x ] I am using node >= 14

---

Steps to Reproduce

import ncu from 'npm-check-updates'

export const upgrades = await ncu({
    // Pass any cli option
    packageFile: './package.json',
    upgrade: false,
    interactive: false,
    filter: 'npm-check-updates'
})

console.log(upgrades)

Steps:

New project using "npm-check-updates": "16.3.0",

Use recommended config, run node foo.js

Current Behavior

Following the README, I have set up a basic js file with the config above. When i run that I get

export const upgrades = await ncu({
                              ^

TypeError: ncu is not a function

I am used Node v16.17.0 and npm 8.15.0. Tried adding and removing "type": "module" from my package.json. Tried in both vanilla js and compiling with tsc.

Expected Behavior

Expected to successfully log

[raineorshine]

Hi, thanks for reporting.

I'm not quite sure what the issue is, as npm-check-updates exports a function run as the default export:

npm-check-updates/src/index.ts

Line 349 in 373441e

export default run

However, it is also exported as a named function, so you can try ncu.run(...) or import { run } from 'npm-check-updates'.

npm-check-updates/src/index.ts

Lines 161 to 164 in 373441e

	export async function run(
	runOptions: RunOptions = {},
	{ cli }: { cli?: boolean } = {},
	): Promise<PackageFile | Index<VersionSpec> | void> {

Here is a sample Typescript repo that compiles correctly with the documented usage:

https://github.com/raineorshine/ncu-test-import-as-module/blob/main/src/index.ts

It basically just consists of:

import ncu from 'npm-check-updates'

const upgrades = await ncu()
console.log(upgrades)

If that doesn't work , try import * as ncu from 'npm-check-updates'. Maybe the method of importing is different if using node v16 without Typescript.

[atomicrobokid]

@raineorshine

Ahh that was the trick, thanks! This is what I needed in the end:

import * as ncu from 'npm-check-updates'

const upgrades = await ncu.run()
console.log(upgrades)

Thanks for your help! :)