stompjs

Stomp.js

Diese Bibliothek bietet einen Stomp -über WebSocket -Client für Webbrowser- und Node.js -Anwendungen.

Bitte besuchen Sie https://stomp-js.github.io/ für Guides, FAQs und API-Dokumente.

Einführung

Mit dieser Bibliothek können Sie über WebSocket eine Verbindung zu einem Stomp -Broker herstellen. Diese Bibliothek unterstützt vollständige STOMP -Spezifikationen, einschließlich aller aktuellen Protokollvarianten. Die beliebtesten Messaging-Broker unterstützen Stomp und Stampfe über Websockets außerhalb des Boxs oder verwenden Plugins.

Merkmale

• Einfache API zur Interaktion mit dem Stomp -Protokoll
• Unterstützung für v1.2, v1.1 und v1.0 des Stomp -Protokolls
• Unterstützung für Fallback -Optionen im Falle von WebSocket nicht verfügbar
• Browser- und Node.js -Unterstützung
• Option zur Verwendung von Stomp über TCP
• Binärnutzlastunterstützung

Verwendung

Browser

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

Weitere Informationen

Die API -Dokumentation wird als Github -Seiten für die Stompjs -Familie von Bibliotheken gehostet. Sie können direkt zum https://stomp-js.github.io/api-docs/latest/ fahren

Diese Bibliothek verfügt über detaillierte Verwendungsanweisungen. Bitte finden Sie es unter den Gebrauchsanweisungen. Schauen Sie sich andere Anleitungen unter https://stomp-js.github.io/ an.

Es gibt eine sehr detaillierte API-Dokumentation.

Upgrade

Wenn Sie eine ältere Version dieser Bibliothek verwenden würden, müssten Sie Änderungen an Ihrem Code vornehmen. Gehen Sie zum Upgrade.

Verwendung mit RXJs

https://github.com/stomp-js/rx-stomp basiert auf dieser Bibliothek und enthält die gesamte von dieser Bibliothek angebotene Funktionalität als RXJS Observables.

TypeScript -Definitionen

Das NPM -Paket enthält TypeScript -Definitionen, sodass es nicht separat installiert werden muss.

Wechseln

Bitte besuchen Sie das Änderungsprotokoll.

Beitragen

Wenn Sie den Code verstehen möchten, entwickeln oder beitragen. Bitte besuchen Sie, wie man einen Beitrag leisten.

Autoren

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

Lizenz

Lizenz - Apache -2.0