Skip to main content

__obs()

Internal

__obs<T>(eventId, object): Observable<T>

Creates an RxJS Observable from a Dart event stream.

Note on double-underscore prefix: This function uses __ to indicate it is a low-level internal utility. While exported for advanced use cases (e.g., custom event handling in packages), prefer using the typed event getters on the Events class (e.g., grok.events.onTableAdded) for type safety and discoverability.

Type parameters

Type parameterValueDescription
TanyType of event data emitted

Parameters

ParameterTypeDefault valueDescription
eventIdstringundefinedEvent identifier (use EVENT_TYPE constants)
objectanynullOptional object to scope events to (null for global events)

Returns

Observable<T>

RxJS Observable that emits event data

Example

// Prefer typed getters:
grok.events.onTableAdded.subscribe(e => console.log(e.args.dataFrame));

// Direct usage (advanced):
__obs(EVENT_TYPE.TABLE_ADDED).subscribe(e => console.log(e));

@internal

Source

src/events.ts:45