\n\n\n\n## Features\n\nā Get `installed` versions of packages *(if installed locally or globally with npm or yarn)* \nā Get `latest` and `next` versions of packages *(from package registries)* \nā Get `wanted` version of packages *(if a version range or a tag is provided)* \nā Check if any `updates` are available \nā Cache support to increase data retrieval performance \nā Support public/private repositories and proxies \nā Dual build support (CJS/ESM) \n\n> š Check out šš» [@badisi/check-updates][checkupdates] \n> An interactive CLI to scan, visualize and upgrade NPM dependencies ā locally or globally !\n\n\n## Installation\n\n```sh\nnpm install @badisi/latest-version --save\n```\n\n```sh\nyarn add @badisi/latest-version\n```\n\n## Usage\n\n__Example__\n\n```ts\n/** CommonJS */\n// const { latestVersion } = require('@badisi/latest-version');\n// const { readFileSync } = require('node:fs');\n\n/** ESM / Typescript */\nimport { latestVersion } from '@badisi/latest-version';\nimport { readFileSync } from 'node:fs';\n\n(async () => {\n // Single package\n const pkg = await latestVersion('npm');\n\n // List of packages\n const pkgs = await latestVersion(['npm', 'npm@1.3.2', 'npm@beta', '@scope/name@^5.0.2']);\n\n // Package.json\n const pkgs = await latestVersion(JSON.parse(readFileSync('package.json').toString()));\n\n // Using cache\n const pkg = await latestVersion('npm@^5.0.2', { useCache: true });\n})();\n```\n\n__Return__\n\nEither a collection or a single `LatestVersionPackage` object:\n\n```ts\ninterface LatestVersionPackage {\n /**\n * The name of the package.\n */\n name: string;\n /**\n * The current local installed version of the package (if installed).\n */\n local?: string;\n /**\n * The current npm global installed version of the package (if installed).\n */\n globalNpm?: string;\n /**\n * The current yarn global installed version of the package (if installed).\n */\n globalYarn?: string;\n /**\n * The latest version of the package found on the registry (if found).\n */\n latest?: string;\n /**\n * The next version of the package found on the registry (if found).\n */\n next?: string;\n /**\n * The tag or version range that was provided (if provided).\n *\n * @default \"latest\"\n */\n wantedTagOrRange?: string;\n /**\n * The latest version of the package found on the registry and satisfied by the wanted tag or version range.\n */\n wanted?: string;\n /**\n * Whether the local or global installed versions (if any) could be upgraded or not, based on the wanted version.\n */\n updatesAvailable: {\n local: string | false;\n globalNpm: string | false;\n globalYarn: string | false;\n } | false;\n /**\n * Any error that might have occurred during the process.\n */\n error?: Error;\n}\n```\n\n__Options__\n\n```ts\ninterface LatestVersionOptions {\n /**\n * Awaiting the api to return might take time, depending on the network, and might impact your package loading performance.\n * You can use the cache mechanism to improve load performance and reduce unnecessary network requests.\n * If `useCache` is not supplied, the api will always check for updates and wait for every requests to return before returning itself.\n * If `useCache` is used, the api will either (for each provided packages):\n * 1) return immediately if a cache was found.\n * 2) fetch and wait for updates of that particular package then creates a cache for it so that it is available for the next call to the api.\n *\n * @default false\n */\n useCache?: boolean;\n\n /**\n * How long the cache for each provided packages should be used before being refreshed (in milliseconds).\n * If `useCache` is not supplied, this option has no effect.\n * If `0` is used, this will force the cache to refresh immediately:\n * 1) New updates will be fetched and waited\n * 2) The cache for each provided packages will be refreshed and made available for the next call to the api\n *\n * @default ONE_DAY\n */\n cacheMaxAge?: number;\n\n /**\n * A JavaScript package registry url that implements the CommonJS Package Registry specification.\n *\n * @default \"Looks at any registry urls in the .npmrc file or fallback to the default npm registry instead\"\n * @example
.npmrc
\n * registry = 'https://custom-registry.com/'\n * @pkgscope:registry = 'https://custom-registry.com/'\n */\n registryUrl?: string;\n\n /**\n * Set of options to be passed down to Node.js http/https request.\n *\n * @example
\n * { rejectUnauthorized: false }\n */\n requestOptions?: RequestOptions;\n}\n```\n\n\n## Development\n\nSee the [developer docs][developer].\n\n\n## Contributing\n\n#### > Want to Help ?\n\nWant to file a bug, contribute some code or improve documentation ? Excellent!\n\nBut please read up first on the guidelines for [contributing][contributing], and learn about submission process, coding rules and more.\n\n#### > Code of Conduct\n\nPlease read and follow the [Code of Conduct][codeofconduct] and help me keep this project open and inclusive.\n\n\n\n\n[checkupdates]: https://github.com/Badisi/check-updates\n[developer]: https://github.com/Badisi/latest-version/blob/main/DEVELOPER.md\n[contributing]: https://github.com/Badisi/latest-version/blob/main/CONTRIBUTING.md\n[codeofconduct]: https://github.com/Badisi/latest-version/blob/main/CODE_OF_CONDUCT.md\n","readmeFilename":"README.md"}
![\"npm](\"https://img.shields.io/npm/v/@badisi/latest-version.svg?color=blue&logo=npm\")
\n \n ![\"npm](\"https://img.shields.io/npm/dw/@badisi/latest-version.svg?color=7986CB&logo=npm\")
\n \n ![\"license\"](\"https://img.shields.io/npm/l/@badisi/latest-version.svg?color=ff69b4\")
\n![\"build](\"https://img.shields.io/github/actions/workflow/status/badisi/latest-version/ci_tests.yml?logo=github\")
![\"PRs](\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\"){kind=icon}