# node-xmpp-component

> Component API for XMPP

Latest version **2.0.9** (published 2017-03-03) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install node-xmpp-component
pnpm add node-xmpp-component
yarn add node-xmpp-component
bun add node-xmpp-component
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.9 |
| Published | 2017-03-03 |
| First published | 2013-11-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2279 |
| Maintainers | astro, chris-rock, lloydwatkin, sonny |
| Keywords | component, XMPP |

## Links

- npm: https://www.npmjs.com/package/node-xmpp-component
- Repository: https://github.com/node-xmpp/node-xmpp
- Homepage: http://github.com/node-xmpp/node-xmpp
- Issues: http://github.com/node-xmpp/node-xmpp/issues
- npm.io page: https://npm.io/package/node-xmpp-component

## Dependencies (1)

- [node-xmpp-core](https://npm.io/package/node-xmpp-core.md) ^5.0.9

## Recent versions

- 2.0.9 (latest) — 2017-03-03
- 2.0.8 — 2017-02-14
- 2.0.7 — 2016-12-10
- 2.0.6 — 2016-12-06
- 2.0.5 — 2016-11-20
- 2.0.4 — 2016-10-16
- 2.0.3 — 2016-10-16
- 6.1.0 — 2016-06-13
- 2.0.2 — 2016-05-19
- 2.0.1 — 2016-02-24
- 2.0.0 — 2015-12-01
- 1.0.0 — 2015-10-06
- 1.0.0-alpha2 — 2015-04-21
- 1.0.0-alpha1 — 2014-04-09
- 0.3.0 — 2014-02-06
- … 10 more at https://npm.io/package/node-xmpp-component/versions

## README

# node-xmpp-component

XMPP component for Node.js

[![build status](https://img.shields.io/travis/node-xmpp/component/master.svg?style=flat-square)](https://travis-ci.org/node-xmpp/component/branches)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)

## Manual

Please see http://node-xmpp.org/doc/component.html for instructions on how to use `node-xmpp-component`.

## Installation

__Note:__ We now only support nodejs versions 0.8.0 and greater.

With package manager [npm](http://npmjs.org/):

    npm install node-xmpp-component

### Testing

Install the dev dependencies, then...

```
npm test
```

Also see the tests run in [travis](http://travis-ci.org/node-xmpp/node-xmpp-component). The tests in travis run both the code and code style tests.

#### Integration tests

There are also a small number of integration tests designed to be run against [Prosody](http://prosody.im). To run these ensure the user the test is run as has sudo access. Copy the prosody configuration file from ```test/resources/prosody.cfg.lua``` to ```/etc/prosody/prosody.cfg.lua```.

## How to use

Please see the various [examples](https://github.com/node-xmpp/node-xmpp/tree/master/packages/node-xmpp-component/examples).

## Objectives of *node-xmpp:*

* Use node.js conventions, especially `EventEmitter`, ie. for write
  buffer control
* Client support for both XMPP clients and components

## Features

* [Component](http://xmpp.org/extensions/xep-0114.html) connections

## Dependencies

* [node-xmpp-core](http://github.com/node-xmpp/node-xmpp-core)

---
_Source: https://npm.io/package/node-xmpp-component · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._