ServerSentEvent React Native Reference Documentation

ServerSentEvent

Current Version: 11.6.1

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, ServerSentEvent } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const serverSentEvent = new ServerSentEvent()
// ... the native object is released when `serverSentEvent` is garbage collected, or now with serverSentEvent.dispose()

Creates the underlying native Chilkat object. ServerSentEvent is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: a method whose only outcome is success or failure returns void and throws on failure; a method producing a string or an object returns it and throws where Chilkat would have returned null. The error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  serverSentEvent.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // ServerSentEvent.someMethod(...): <reason>
  console.log(serverSentEvent.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await serverSentEvent.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // ServerSentEvent.someMethodAsync: <reason>
}

Properties

Data

DebugLogFilePath

EventName

LastErrorHtml

LastErrorText

LastErrorXml

LastEventId

LastMethodSuccess

Retry

VerboseLogging

Version

Methods

LoadEvent

event: put
data: {"path": "/c", "data": {"foo": true, "bar": false}}