# @nteract/messaging

> Messaging mechanics for nteract apps (jupyter spec)

Latest version **7.0.20** (published 2021-10-22) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @nteract/messaging
pnpm add @nteract/messaging
yarn add @nteract/messaging
bun add @nteract/messaging
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.0.20 |
| Published | 2021-10-22 |
| First published | 2017-02-17 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 940 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Kyle Kelley |
| Maintainers | benabel, alexandercbooth, benrussert, mpacer, theengineear, yuvipanda, rgbkrk, lgeiger, ivanov, captainsafia, peggyrayzis, jdetle, hasch, willingc, stormpython, crystalline-cat, emeeks, hydrosquall |
| Keywords | nteract, messaging, jmp, jupyter |

## Links

- npm: https://www.npmjs.com/package/@nteract/messaging
- npm.io page: https://npm.io/package/@nteract/messaging

## Dependencies (5)

- [rxjs](https://npm.io/package/rxjs.md) ^6.6.0
- [uuid](https://npm.io/package/uuid.md) ^8.0.0
- [@types/uuid](https://npm.io/package/@types/uuid.md) ^8.0.0
- [@nteract/types](https://npm.io/package/@nteract/types.md) ^7.1.9
- [lodash.clonedeep](https://npm.io/package/lodash.clonedeep.md) ^4.5.0

## Recent versions

- 7.0.20 (latest) — 2021-10-22
- 7.0.16-alpha.0 (prerelease) — 2020-12-08
- 7.0.6-alpha.0 (pre) — 2020-04-21
- 7.0.19 — 2021-06-20
- 7.0.18 — 2021-04-30
- 7.0.17 — 2021-02-23
- 7.0.16 — 2021-01-26
- 7.0.15-alpha.0 — 2020-12-08
- 7.0.14 — 2020-12-04
- 7.0.13 — 2020-12-01
- 7.0.12 — 2020-10-26
- 7.0.11 — 2020-09-29
- 7.0.10 — 2020-09-01
- 7.0.9 — 2020-07-28
- 7.0.8 — 2020-06-29
- … 79 more at https://npm.io/package/@nteract/messaging/versions

## README

# @nteract/messaging

This package contains type definitions and helper functions for interacting with the [Jupyter Messaging Protocol](https://jupyter-client.readthedocs.io/en/stable/messaging.html). These functions can be used to create different types of request and response messages.

## Installation

```
$ yarn add @nteract/messaging
```

```
$ npm install --save @nteract/messaging
```

## Usage

The example below shows how we can use the `createMessage` function in this package to create an [inspect_request](https://jupyter-client.readthedocs.io/en/stable/messaging.html#introspection) Jupyter message.

```javascript
import { createMessage } from "@nteract/messaging";

const message = createMessage("inspect_request", {
  code: "string.for",
  cursor_pos: 10,
  detail_level: 1
});
```

## Documentation

You can view the reference documentation for `@nteract/messaging` in the [package docs](https://packages.nteract.io/modules/messaging.html).

## Support

If you experience an issue while using this package or have a feature request, please file an issue on the [issue board](https://github.com/nteract/nteract/issues/new/choose) and add the `pkg:messaging` label.

## License

[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)

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