{"id":22820664,"url":"https://github.com/tunnckoCore/detect-installed","last_synced_at":"2025-08-10T11:31:51.264Z","repository":{"id":30375426,"uuid":"33928034","full_name":"tunnckoCore/detect-installed","owner":"tunnckoCore","description":"Checks that given package name is installed locally or globally. Support sync and callback api.","archived":false,"fork":false,"pushed_at":"2023-01-12T04:25:32.000Z","size":438,"stargazers_count":10,"open_issues_count":10,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-09T12:46:43.638Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://j.mp/1yAjqjm","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tunnckoCore.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"ko_fi":"tunnckoCore","custom":["https://gumroad.com/l/tunnckoCoreRecurringDonation"]}},"created_at":"2015-04-14T11:33:33.000Z","updated_at":"2020-03-17T15:11:40.000Z","dependencies_parsed_at":"2023-01-14T17:00:35.751Z","dependency_job_id":null,"html_url":"https://github.com/tunnckoCore/detect-installed","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fdetect-installed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fdetect-installed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fdetect-installed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fdetect-installed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tunnckoCore","download_url":"https://codeload.github.com/tunnckoCore/detect-installed/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229406100,"owners_count":18067997,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-12T15:26:56.864Z","updated_at":"2024-12-12T15:26:59.602Z","avatar_url":"https://github.com/tunnckoCore.png","language":"JavaScript","readme":"# detect-installed [![NPM version](https://img.shields.io/npm/v/detect-installed.svg?style=flat)](https://www.npmjs.com/package/detect-installed) [![NPM downloads](https://img.shields.io/npm/dm/detect-installed.svg?style=flat)](https://npmjs.org/package/detect-installed) [![npm total downloads][downloads-img]][downloads-url]\n\n\u003e Checks that given package is installed globally or locally.\n\n[![code climate][codeclimate-img]][codeclimate-url] \n[![standard code style][standard-img]][standard-url] \n[![linux build status][travis-img]][travis-url] \n[![windows build status][appveyor-img]][appveyor-url] \n[![coverage status][coveralls-img]][coveralls-url] \n[![dependency status][david-img]][david-url]\n\nYou might also be interested in [get-installed-path](https://github.com/tunnckocore/get-installed-path#readme).\n\n## Table of Contents\n- [Install](#install)\n- [Usage](#usage)\n- [API](#api)\n  * [detectInstalled](#detectinstalled)\n  * [.sync](#sync)\n- [Related](#related)\n- [Contributing](#contributing)\n- [Building docs](#building-docs)\n- [Running tests](#running-tests)\n- [Author](#author)\n- [License](#license)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Install\nInstall with [npm](https://www.npmjs.com/)\n\n```\n$ npm install detect-installed --save\n```\n\nor install using [yarn](https://yarnpkg.com)\n\n```\n$ yarn add detect-installed\n```\n\n## Usage\n\u003e For more use-cases see the [tests](test.js)\n\n```js\nconst detectInstalled = require('detect-installed')\n```\n\n## API\n\n### [detectInstalled](index.js#L60)\n\u003e Detect if some package `name`is installed globally or locally. By default checks if it exists in globally installed modules, using [global-modules][]. Pass `opts.local` to check if it exists in locally installed modules or in `opts.cwd` dir.\n\n**Params**\n\n* `name` **{String}**: package name    \n* `opts` **{Object}**: pass `opts.local` to check locally    \n* `returns` **{Promise}**: always resolved promise, never rejected  \n\n**Example**\n\n```js\nconst detectInstalled = require('detect-installed')\n\ndetectInstalled('npm').then((exists) =\u003e {\n  console.log(exists) // =\u003e true\n})\n\ndetectInstalled('foo-bar-barwerwlekrjw').then((exists) =\u003e {\n  console.log(exists) // =\u003e false\n})\n\ndetectInstalled('npm', {\n  local: true\n}).then((exists) =\u003e {\n  console.log(exists) // =\u003e false\n})\n\ndetectInstalled('global-modules', {\n  local: true\n}).then((exists) =\u003e {\n  console.log(exists) // =\u003e true\n})\n\n// If you are using it for some sub-directory\n// pass `opts.cwd` to be where the `node_modules`\n// folder is.\nprocess.chidr('foo-bar-baz')\ndetectInstalled('global-modules', {\n  local: true,\n  cwd: '../'\n}).then((exists) =\u003e console.log(exists)) // =\u003e true\n```\n\n### [.sync](index.js#L86)\n\u003e Synchronously check if package `name` exists as locally or globally installed modules.\n\n**Params**\n\n* `name` **{String}**: package name    \n* `opts` **{Object}**: pass `opts.local` to check locally    \n* `returns` **{Boolean}**: false, if error or not exists globally/locally  \n\n**Example**\n\n```js\nconst detectInstalled = require('detect-installed')\n\nconst exists = detectInstalled.sync('npm') // =\u003e true\nconst result = detectInstalled.sync('global-modules', { local: true }) // =\u003e true\n```\n\n## Related\n- [always-done](https://www.npmjs.com/package/always-done): Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… [more](https://github.com/hybridables/always-done#readme) | [homepage](https://github.com/hybridables/always-done#readme \"Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement for [async-done][] - pass 100% of its tests plus more\")\n- [get-installed-path](https://www.npmjs.com/package/get-installed-path): Get locally or globally installation path of given package name | [homepage](https://github.com/tunnckocore/get-installed-path#readme \"Get locally or globally installation path of given package name\")\n- [global-modules](https://www.npmjs.com/package/global-modules): The directory used by npm for globally installed npm modules. | [homepage](https://github.com/jonschlinkert/global-modules \"The directory used by npm for globally installed npm modules.\")\n- [is-installed](https://www.npmjs.com/package/is-installed): Checks that given package is installed on the system - globally or locally. | [homepage](https://github.com/tunnckoCore/is-installed#readme \"Checks that given package is installed on the system - globally or locally.\")\n- [minibase](https://www.npmjs.com/package/minibase): Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… [more](https://github.com/node-minibase/minibase#readme) | [homepage](https://github.com/node-minibase/minibase#readme \"Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins.\")\n- [try-catch-core](https://www.npmjs.com/package/try-catch-core): Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and… [more](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme \"Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.\")\n\n## Contributing\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/detect-installed/issues/new).  \nPlease read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards.  \nIf you need some help and can spent some cash, feel free to [contact me at CodeMentor.io](https://www.codementor.io/tunnckocore?utm_source=github\u0026utm_medium=button\u0026utm_term=tunnckocore\u0026utm_campaign=github) too.\n\n**In short:** If you want to contribute to that project, please follow these things\n\n1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See [\"Building docs\"](#building-docs) section.\n2. Ensure anything is okey by installing the dependencies and run the tests. See [\"Running tests\"](#running-tests) section.\n3. Always use `npm run commit` to commit changes instead of `git commit`, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.\n4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy.\n\nThanks a lot! :)\n\n## Building docs\nDocumentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run `verb` command like that\n\n```\n$ npm install verbose/verb#dev verb-generate-readme --global \u0026\u0026 verb\n```\n\n_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._\n\n## Running tests\nClone repository and run the following in that cloned directory\n\n```\n$ npm install \u0026\u0026 npm test\n```\n\n## Author\n**Charlike Mike Reagent**\n\n+ [github/tunnckoCore](https://github.com/tunnckoCore)\n+ [twitter/tunnckoCore](http://twitter.com/tunnckoCore)\n+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)\n\n## License\nCopyright © 2016, [Charlike Mike Reagent](http://i.am.charlike.online). Released under the [MIT license](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 11, 2016._  \n_Project scaffolded using [charlike][] cli._\n\n[always-done]: https://github.com/hybridables/always-done\n[async-done]: https://github.com/gulpjs/async-done\n[base]: https://github.com/node-base/base\n[charlike]: https://github.com/tunnckocore/charlike\n[commitizen]: https://github.com/commitizen/cz-cli\n[dezalgo]: https://github.com/npm/dezalgo\n[once]: https://github.com/isaacs/once\n[standard-version]: https://github.com/conventional-changelog/standard-version\n[verb-generate-readme]: https://github.com/verbose/verb-generate-readme\n[verb]: https://github.com/verbose/verb\n\n[downloads-url]: https://www.npmjs.com/package/detect-installed\n[downloads-img]: https://img.shields.io/npm/dt/detect-installed.svg\n\n[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/detect-installed\n[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/detect-installed.svg\n\n[travis-url]: https://travis-ci.org/tunnckoCore/detect-installed\n[travis-img]: https://img.shields.io/travis/tunnckoCore/detect-installed/master.svg?label=linux\n\n[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/detect-installed\n[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/detect-installed/master.svg?label=windows\n\n[coveralls-url]: https://coveralls.io/r/tunnckoCore/detect-installed\n[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/detect-installed.svg\n\n[david-url]: https://david-dm.org/tunnckoCore/detect-installed\n[david-img]: https://img.shields.io/david/tunnckoCore/detect-installed.svg\n\n[standard-url]: https://github.com/feross/standard\n[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg\n\n[global-modules]: https://github.com/jonschlinkert/global-modules","funding_links":["https://ko-fi.com/tunnckoCore","https://gumroad.com/l/tunnckoCoreRecurringDonation"],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FtunnckoCore%2Fdetect-installed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FtunnckoCore%2Fdetect-installed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FtunnckoCore%2Fdetect-installed/lists"}