Class LiveClient

Index

Constructors

Methods

Constructors

constructor

new LiveClient(client: ObservableSanityClient | SanityClient): LiveClient
Parameters
- client: ObservableSanityClient | SanityClient
Returns LiveClient
- Defined in src/data/live.ts:29

Methods

events

events(
__namedParameters?: { includeDrafts?: boolean; tag?: string },
): Observable<LiveEvent>
Requires apiVersion to be 2021-03-25 or later.
Parameters
- __namedParameters: { includeDrafts?: boolean; tag?: string } = {}
  - OptionalincludeDrafts?: boolean
  - Optionaltag?: string
    Optional request tag for the listener. Use to identify the request in logs.
    
    Default Value
    undefined
Returns Observable<LiveEvent>
- Defined in src/data/live.ts:36