Docs: run the api-extractor on master to update docs (#23726)
* regenerated packages docs. * fixed spelling issues. * fixed spelling issues.
This commit is contained in:
@@ -10,6 +10,8 @@ draft = true
|
||||
|
||||
## EchoSrv interface
|
||||
|
||||
Used to send events to all the registered backends. This should be accessed via the [getEchoSrv()](./runtime/getechosrv.md) function. Will, by default, flush events to the backends every 10s or when the flush function is triggered.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@@ -24,12 +26,14 @@ import { EchoSrv } from '@grafana/runtime';
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [addBackend(backend)](#addbackend-method) | |
|
||||
| [addEvent(event, meta)](#addevent-method) | |
|
||||
| [flush()](#flush-method) | |
|
||||
| [addBackend(backend)](#addbackend-method) | Add a new echo backend to the list of backends that will receive events. |
|
||||
| [addEvent(event, meta)](#addevent-method) | Call this to add event that will be sent to the echo backends upon next flush. |
|
||||
| [flush()](#flush-method) | Call this to flush current events to the echo backends. |
|
||||
|
||||
### addBackend method
|
||||
|
||||
Add a new echo backend to the list of backends that will receive events.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@@ -47,6 +51,8 @@ addBackend(backend: EchoBackend): void;
|
||||
|
||||
### addEvent method
|
||||
|
||||
Call this to add event that will be sent to the echo backends upon next flush.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@@ -56,8 +62,8 @@ addEvent<T extends EchoEvent>(event: Omit<T, 'meta'>, meta?: {}): void;
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| event | <code>Omit<T, 'meta'></code> | |
|
||||
| meta | <code>{}</code> | |
|
||||
| event | <code>Omit<T, 'meta'></code> | Object containing event information. |
|
||||
| meta | <code>{}</code> | Object that will extend/override the default meta object. |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
@@ -65,6 +71,8 @@ addEvent<T extends EchoEvent>(event: Omit<T, 'meta'>, meta?: {}): void;
|
||||
|
||||
### flush method
|
||||
|
||||
Call this to flush current events to the echo backends.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
Reference in New Issue
Block a user