stompjs

Stomp.js

Esta biblioteca fornece um cliente do WebSocket para o Web Browser e o Node.js Applications.

Visite https://stomp-js.github.io/ para guias, perguntas frequentes e documentos da API.

Introdução

Esta biblioteca permite que você se conecte a um corretor Stomp sobre o WebSocket. Esta biblioteca suporta especificações completas de Stomp, incluindo todas as variantes de protocolo atuais. Os corretores de mensagens mais populares suportam o STOMP e Stomp sobre os WebSockets prontos para uso ou usando plugins.

Características

• API simples para interagir com o protocolo Stomp
• Suporte para v1.2, v1.1 e v1.0 do protocolo Stomp
• Suporte para opções de fallback no caso de WebSocket indisponível
• Suporte para navegador e node.js
• Opção para usar Stomp Over TCP
• Suporte binário em carga útil

Uso

Navegador

 <!--
    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 ( ) ; 

Mais informações

A documentação da API é hospedada como páginas do Github para a família de bibliotecas Stompjs. Você pode ir direto para o https://stomp-js.github.io/api-docs/latest/

Esta biblioteca vem com instruções de uso detalhadas. Por favor, encontre -o nas instruções de uso. Confira outros guias em https://stomp-js.github.io/.

Há documentação da API bastante detalhada, você deve começar em https://stomp-js.github.io/api-docs/latest/classes/client.html.

Atualização

Se você estivesse usando uma versão mais antiga desta biblioteca, precisaria fazer alterações no seu código. Vá para atualizar.

Uso com RXJs

https://github.com/stomp-js/rx-stomp é baseado nesta biblioteca e expõe toda a funcionalidade oferecida por esta biblioteca como RXJS Observables.

Definições de TypeScript

O pacote NPM inclui definições do TypeScript; portanto, não há necessidade de instalá -lo separadamente.

Mudança de log

Por favor, visite alterar log.

Contribuindo

Se você deseja entender o código, desenvolver ou contribuir. Por favor, visite como contribuir.

Autores

• Jeff Mesnil
• Jeff Lindsay
• Vanessa Williams
• Deepak Kumar
• Astha profunda
• Dillon Sellars
• Jimi Charalampidis
• Raul
• Dimitar Georgiev
• Genadi
• Bobohuochai
• Sailai

Licença

Licença - Apache -2.0