stompjs

Stomp.js

Эта библиотека обеспечивает топо для клиента WebSocket для веб -браузера и приложений Node.js.

Пожалуйста, посетите https://stomp-js.github.io/ для руководств, часто задаваемых вопросов и документов API.

Введение

Эта библиотека позволяет подключаться к брокеру Stomp через WebSocket. Эта библиотека поддерживает полные спецификации Stomp, включая все текущие варианты протокола. Большинство популярных брокеров обмена сообщениями поддерживают STOMP и STOMP за веб-битвами или использовали плагины.

Функции

• Простой API для взаимодействия с протоколом Stomp
• Поддержка V1.2, V1.1 и V1.0 протокола Stomp
• Поддержка вариантов отступления в случае отсутствия WebSocket
• Поддержка браузера и Node.js
• Возможность использовать STOMP Over TCP
• Двуичная поддержка полезной нагрузки

Использование

Браузер

 <!--
    JSPM Generator Import Map
    Edit URL: https://generator.jspm.io/#U2NgYGBkDM0rySzJSU1hcCguyc8t0AeTWcUO5noGega6SakliaYAYTzJAykA
  -->
< script type =" importmap " >
  {
    "imports" : {
      "@stomp/stompjs" : "https://ga.jspm.io/npm:@stomp/[email protected]/esm6/index.js"
    }
  }
</ script >

<!-- ES Module Shims: Import maps polyfill for modules browsers without import maps support (all except Chrome 89+) -->
< script
  async
  src =" https://ga.jspm.io/npm:[email protected]/dist/es-module-shims.js "
  crossorigin =" anonymous "
> </ script >

< script type =" module " >
  import { Client } from '@stomp/stompjs' ;

  const client = new Client ( {
    brokerURL : 'ws://localhost:15674/ws' ,
    onConnect : ( ) => {
      client . subscribe ( '/topic/test01' , message =>
        console . log ( `Received: ${ message . body } ` )
      ) ;
      client . publish ( { destination : '/topic/test01' , body : 'First Message' } ) ;
    } ,
  } ) ;

  client . activate ( ) ;
</ script >

Nodejs

$ npm install @stomp/stompjs ws

 import { Client } from '@stomp/stompjs' ;

import { WebSocket } from 'ws' ;
Object . assign ( global , { WebSocket } ) ;

const client = new Client ( {
  brokerURL : 'ws://localhost:15674/ws' ,
  onConnect : ( ) => {
    client . subscribe ( '/topic/test01' , message =>
      console . log ( `Received: ${ message . body } ` )
    ) ;
    client . publish ( { destination : '/topic/test01' , body : 'First Message' } ) ;
  } ,
} ) ;

client . activate ( ) ; 

Дополнительная информация

Документация API размещена как страницы GitHub для семейства библиотек Stompjs. Вы можете отправиться прямо в https://stomp-js.github.io/api-docs/latest/

Эта библиотека поставляется с подробными инструкциями по использованию. Пожалуйста, найдите это в инструкциях по использованию. Проверьте другие гиды на https://stomp-js.github.io/.

Существует довольно подробная документация по API, вы должны начать по адресу https://stomp-js.github.io/api-docs/latest/classes/client.html.

Обновление

Если бы вы использовали более старую версию этой библиотеки, вам нужно было внести изменения в свой код. Отправляйтесь в обновление.

Использование с RXJS

https://github.com/stomp-js/rx-stomp основан на этой библиотеке и раскрывает всю функциональность, предлагаемую этой библиотекой как RXJS.

Определения типографии

Пакет NPM включает в себя определения TypeScript, поэтому нет необходимости устанавливать его отдельно.

Изменение-лог

Пожалуйста, посетите журнал изменений.

Внося

Если вы хотите понять код, разрабатывать или внести свой вклад. Пожалуйста, посетите, как внести свой вклад.

Авторы

• Джефф Меснил
• Джефф Линдсей
• Ванесса Уильямс
• Дипак Кумар
• Астха глубоко
• Диллон Селларс
• Джими Чаралампидис
• Рауль
• Dimitar Georgiev
• Genadi
• Bobohuochai
• Салай

Лицензия

Лицензия - Apache -2.0