stompjs

Stomp.js

Esta biblioteca proporciona un cliente STOMP sobre WebSocket para el navegador web y las aplicaciones Node.js.

Visite https://stomp-js.github.io/ para guías, preguntas frecuentes y documentos API.

Introducción

Esta biblioteca le permite conectarse a un corredor de Stomp sobre WebSocket. Esta biblioteca admite especificaciones completas de Stomp, incluidas todas las variantes de protocolo actuales. Los corredores de mensajería más populares admiten pisotear y pisotear sobre WebSocket fuera de la caja o usar complementos.

Características

• API simple para interactuar con el protocolo de Stomp
• Soporte para V1.2, V1.1 y V1.0 del protocolo STOMP
• Soporte para opciones de retroceso en caso de que WebSocket no esté disponible
• Soporte de navegador y node.js
• Opción para usar Stomp sobre TCP
• Soporte de carga útil binaria

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

Más información

La documentación de la API está alojada como páginas de GitHub para la familia de bibliotecas Stompjs. Puede dirigirse directamente al https://stomp-js.github.io/api-docs/latest/

Esta biblioteca viene con instrucciones de uso detalladas. Por favor, busque en instrucciones de uso. Echa un vistazo a otras guías en https://stomp-js.github.io/.

Hay documentación de API bastante detallada, debe comenzar en https://stomp-js.github.io/api-docs/latest/classes/client.html.

Actualización

Si estuviera utilizando una versión anterior de esta biblioteca, necesitaría hacer cambios en su código. Dirígete a la actualización.

Uso con RXJS

https://github.com/stomp-js/rx-stomp se basa en esta biblioteca y expone toda la funcionalidad ofrecida por esta biblioteca como RXJS Observables.

Definiciones mecanografiadas

El paquete NPM incluye definiciones de TypeScript, por lo que no es necesario instalarlo por separado.

Registro de cambio

Visite el registro de cambios.

Que contribuye

Si desea comprender el código, desarrollar o contribuir. Visite cómo contribuir.

Autores

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

Licencia

Licencia - Apache -2.0