https://github.com/jonschlinkert/yarn-api
Basic API for yarn.
https://github.com/jonschlinkert/yarn-api
api yarn
Last synced: about 1 year ago
JSON representation
Basic API for yarn.
- Host: GitHub
- URL: https://github.com/jonschlinkert/yarn-api
- Owner: jonschlinkert
- License: mit
- Created: 2017-04-27T05:33:45.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-05-19T17:47:43.000Z (about 8 years ago)
- Last Synced: 2025-04-10T18:57:51.489Z (about 1 year ago)
- Topics: api, yarn
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert/yarn-api
- Size: 15.6 KB
- Stars: 28
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# yarn-api [](https://www.npmjs.com/package/yarn-api) [](https://npmjs.org/package/yarn-api) [](https://npmjs.org/package/yarn-api) [](https://travis-ci.org/jonschlinkert/yarn-api)
> Basic API for yarn.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save yarn-api
```
Install with [yarn](https://yarnpkg.com):
```sh
$ yarn add yarn-api
```
## Usage
```js
var yarn = require('yarn-api');
yarn(['why', 'isobject'], function(err) {
if (err) throw err;
});
```
## API
### [yarn](index.js#L33)
Run `yarn` with the given `cmds`, `args` and callback.
**Params**
* `cmds` **{String|Array}**
* `args` **{String|Array}**
* `cb` **{Function}**: Callback
**Example**
```js
yarn(['add', 'isobject'], function(err) {
if (err) throw err;
});
```
.link
### [.link](index.js#L59)
Symlink the current project to global `node_modules`. Visit the yarn docs for [link](https://yarnpkg.com/en/docs/cli/link).
**Params**
* `cb` **{Function}**: Callback
**Example**
```js
yarn.link(function(err) {
if (err) throw err;
});
```
.unlink
### [.unlink](index.js#L76)
Unlink a previously created symlink for a package. Visit the yarn docs for [unlink](https://yarnpkg.com/en/docs/cli/unlink).
**Params**
* `cb` **{Function}**: Callback
**Example**
```js
yarn.unlink(function(err) {
if (err) throw err;
});
```
.add
### [.add](index.js#L95)
Installs one or more packages and any packages they depend on.
Visit the yarn docs for [add](https://yarnpkg.com/en/docs/cli/add).
**Params**
* `names` **{String|Array}**: package names
* `cb` **{Function}**: Callback
**Example**
```js
yarn.add('isobject', function(err) {
if (err) throw err;
});
```
.global
### [.global](index.js#L113)
Execute `yarn add --global` with one or more package `names`.
**Params**
* `names` **{String|Array}**: One or more package names to install
* `cb` **{Function}**: Callback
**Example**
```js
yarn.global('mocha', function(err) {
if (err) throw err;
});
```
.install
### [.install](index.js#L133)
Install all dependencies for a project. This is most commonly used when you have just checked out code for a project, or when another developer on the project has added a new dependency that you need to pick up.
Visit the yarn docs for [install](https://yarnpkg.com/en/docs/cli/install).
**Params**
* `cb` **{Function}**: Callback
**Example**
```js
yarn.install(function(err) {
if (err) throw err;
});
```
.outdated
### [.outdated](index.js#L152)
Checks for outdated package dependencies.
Visit the yarn docs for [outdated](https://yarnpkg.com/en/docs/cli/outdated)
**Params**
* `names` **{String|Array}**: package names
* `cb` **{Function}**: Callback
**Example**
```js
yarn.outdated('isobject', function(err) {
if (err) throw err;
});
```
.upgrade
### [.upgrade](index.js#L172)
Updates all dependencies to their latest version based on the version range specified in the package.json file. The `yarn.lock` file will be (re)created as well.
Visit the yarn docs for [upgrade](https://yarnpkg.com/en/docs/cli/upgrade).
**Params**
* `cb` **{Function}**: Callback
**Example**
```js
yarn.upgrade(function(err) {
if (err) throw err;
});
```
.remove
### [.remove](index.js#L192)
Remove a package from your direct dependencies, updating your package.json and yarn.lock files in the process.
Visit the yarn docs for [remove](https://yarnpkg.com/en/docs/cli/remove).
**Params**
* `args` **{Function}**
* `cb` **{Function}**: Callback
**Example**
```js
yarn.remove('isobject', function(err) {
if (err) throw err;
});
```
.why
### [.why](index.js#L211)
Show information about why a package is installed.
Visit the yarn docs for [why](https://yarnpkg.com/en/docs/cli/why).
**Params**
* `args` **{Function}**
* `cb` **{Function}**: Callback
**Example**
```js
yarn.why('isobject', function(err) {
if (err) throw err;
});
```
.dependencies
### [.dependencies](index.js#L229)
Execute `yarn add` with one or more package `names`. Updates `dependencies` in package.json.
**Params**
* `names` **{String|Array}**: One or more package names to install
* `cb` **{Function}**: Callback
**Example**
```js
yarn.dependencies('micromatch', function(err) {
if (err) throw err;
});
```
.devDependencies
### [.devDependencies](index.js#L253)
Execute `yarn add --dev` with one or more package `names`. Updates `devDependencies` in package.json.
**Params**
* `names` **{String|Array}**: One or more package names to install
* `cb` **{Function}**: Callback
**Example**
```js
// defined as a string
yarn.devDependencies('micromatch', function(err) {
if (err) throw err;
});
// or as an array
yarn.devDependencies(['micromatch', 'is-glob'], function(err) {
if (err) throw err;
});
```
.peerDependencies
### [.peerDependencies](index.js#L271)
Execute `yarn add --peer` with one or more package `names`. Updates `peerDependencies` in package.json.
**Params**
* `names` **{String|Array}**: One or more package names to install
* `cb` **{Function}**: Callback
**Example**
```js
yarn.peerDependencies('isobject', function(err) {
if (err) throw err;
});
```
.optionalDependencies
### [.optionalDependencies](index.js#L289)
Execute `yarn add --optional` with one or more package `names`. Updates `optionalDependencies` in package.json.
**Params**
* `names` **{String|Array}**: One or more package names to install
* `cb` **{Function}**: Callback
**Example**
```js
yarn.optionalDependencies('isobject', function(err) {
if (err) throw err;
});
```
## About
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on April 27, 2017._