ObservableQuery | helyOS-JavaScript-SDK

Type parameters

TData = any
TVariables = OperationVariables

Hierarchy

<internal>.Observable<ApolloQueryResult<TData>>
- ObservableQuery

Constructors

constructor

new ObservableQuery<TData, TVariables>(__namedParameters: { options: WatchQueryOptions<TVariables>; queryManager: QueryManager<any>; shouldSubscribe?: boolean }): ObservableQuery<TData, TVariables>

Overrides Observable.constructor
- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:49
Type parameters
- TData = any
- TVariables = OperationVariables
Parameters
- __namedParameters: { options: WatchQueryOptions<TVariables>; queryManager: QueryManager<any>; shouldSubscribe?: boolean }
  - options: WatchQueryOptions<TVariables>
  - queryManager: QueryManager<any>
  - Optional shouldSubscribe?: boolean
Returns ObservableQuery<TData, TVariables>

Properties

options

options: WatchQueryOptions<TVariables>

Readonly queryId

queryId: string

Optional Readonly queryName

queryName?: string

variables

variables: TVariables

Methods

currentResult

currentResult(): ApolloCurrentResult<TData>

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:55
Returns ApolloCurrentResult<TData>

fetchMore

fetchMore<K>(fetchMoreOptions: FetchMoreQueryOptions<TVariables, K> & FetchMoreOptions<TData, TVariables>): Promise<ApolloQueryResult<TData>>

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:63
Type parameters
- K: string | number | symbol
Parameters
- fetchMoreOptions: FetchMoreQueryOptions<TVariables, K> & FetchMoreOptions<TData, TVariables>
Returns Promise<ApolloQueryResult<TData>>

filter

filter(fn: (value: ApolloQueryResult<TData>) => boolean): <internal>.Observable<ApolloQueryResult<TData>>

Inherited from Observable.filter
- Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:15
Parameters
- fn: (value: ApolloQueryResult<TData>) => boolean
  - - (value: ApolloQueryResult<TData>): boolean
    - Parameters
      - value: ApolloQueryResult<TData>
      Returns boolean
Returns <internal>.Observable<ApolloQueryResult<TData>>

flatMap

flatMap<R>(fn: (value: ApolloQueryResult<TData>) => ObservableLike<R>): <internal>.Observable<R>

Inherited from Observable.flatMap
- Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:17
Type parameters
- R
Parameters
- fn: (value: ApolloQueryResult<TData>) => ObservableLike<R>
  - - (value: ApolloQueryResult<TData>): ObservableLike<R>
    - Parameters
      - value: ApolloQueryResult<TData>
      Returns ObservableLike<R>
Returns <internal>.Observable<R>

forEach

forEach(fn: (value: ApolloQueryResult<TData>) => void): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:13
Parameters
- fn: (value: ApolloQueryResult<TData>) => void
  - - (value: ApolloQueryResult<TData>): void
    - Parameters
      - value: ApolloQueryResult<TData>
      Returns void
Returns Promise<void>

from

from<R>(observable: <internal>.Observable<R> | ObservableLike<R> | ArrayLike<R>): <internal>.Observable<R>

Inherited from Observable.from
- Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:18
Type parameters
- R
Parameters
- observable: <internal>.Observable<R> | ObservableLike<R> | ArrayLike<R>
Returns <internal>.Observable<R>

getCurrentResult

getCurrentResult(): ApolloCurrentQueryResult<TData>

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:56
Returns ApolloCurrentQueryResult<TData>

getLastError

getLastError(): ApolloError

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:59
Returns ApolloError

getLastResult

getLastResult(): ApolloQueryResult<TData>

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:58
Returns ApolloQueryResult<TData>

isDifferentFromLastResult

isDifferentFromLastResult(newResult: ApolloQueryResult<TData>): boolean

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:57
Parameters
- newResult: ApolloQueryResult<TData>
Returns boolean

map

map<R>(fn: (value: ApolloQueryResult<TData>) => R): <internal>.Observable<R>

Inherited from Observable.map
- Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:14
Type parameters
- R
Parameters
- fn: (value: ApolloQueryResult<TData>) => R
  - - (value: ApolloQueryResult<TData>): R
    - Parameters
      - value: ApolloQueryResult<TData>
      Returns R
Returns <internal>.Observable<R>

of

of<R>(...args: R[]): <internal>.Observable<R>

Inherited from Observable.of
- Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:19
Type parameters
- R
Parameters
- Rest ...args: R[]
Returns <internal>.Observable<R>

reduce

reduce<R>(fn: (previousValue: ApolloQueryResult<TData> | R, currentValue: ApolloQueryResult<TData>) => ApolloQueryResult<TData> | R, initialValue?: ApolloQueryResult<TData> | R): <internal>.Observable<ApolloQueryResult<TData> | R>

Inherited from Observable.reduce
- Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:16
Type parameters
- R = ApolloQueryResult<TData>
Parameters
- fn: (previousValue: ApolloQueryResult<TData> | R, currentValue: ApolloQueryResult<TData>) => ApolloQueryResult<TData> | R
  - - (previousValue: ApolloQueryResult<TData> | R, currentValue: ApolloQueryResult<TData>): ApolloQueryResult<TData> | R
    - Parameters
      - previousValue: ApolloQueryResult<TData> | R
      - currentValue: ApolloQueryResult<TData>
      Returns ApolloQueryResult<TData> | R
- Optional initialValue: ApolloQueryResult<TData> | R
Returns <internal>.Observable<ApolloQueryResult<TData> | R>

refetch

refetch(variables?: TVariables): Promise<ApolloQueryResult<TData>>

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:62
Parameters
- Optional variables: TVariables
Returns Promise<ApolloQueryResult<TData>>

resetLastResults

resetLastResults(): void

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:60
Returns void

resetQueryStoreErrors

resetQueryStoreErrors(): void

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:61
Returns void

result

result(): Promise<ApolloQueryResult<TData>>

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:54
Returns Promise<ApolloQueryResult<TData>>

setOptions

setOptions(opts: WatchQueryOptions<OperationVariables>): Promise<void | ApolloQueryResult<TData>>

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:65
Parameters
- opts: WatchQueryOptions<OperationVariables>
Returns Promise<void | ApolloQueryResult<TData>>

setVariables

setVariables(variables: TVariables, tryFetch?: boolean, fetchResults?: boolean): Promise<void | ApolloQueryResult<TData>>

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:66
Parameters
- variables: TVariables
- Optional tryFetch: boolean
- Optional fetchResults: boolean
Returns Promise<void | ApolloQueryResult<TData>>

startPolling

startPolling(pollInterval: number): void

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:69
Parameters
- pollInterval: number
Returns void

stopPolling

stopPolling(): void

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:68
Returns void

subscribe(observerOrNext: ((value: ApolloQueryResult<TData>) => void) | <internal>.Observer<ApolloQueryResult<TData>>, error?: (error: any) => void, complete?: () => void): <internal>.Subscription

Inherited from Observable.subscribe
- Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:12
Parameters
- observerOrNext: ((value: ApolloQueryResult<TData>) => void) | <internal>.Observer<ApolloQueryResult<TData>>
- Optional error: (error: any) => void
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: () => void
  - - (): void
    - Returns void
Returns <internal>.Subscription

subscribeToMore

subscribeToMore<TSubscriptionData, TSubscriptionVariables>(options: SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData>): () => void

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:64
Type parameters
- TSubscriptionData = TData
- TSubscriptionVariables = TVariables
Parameters
- options: SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData>
Returns () => void
- - (): void
  - Returns void

updateQuery

updateQuery<TVars>(mapFn: (previousQueryResult: TData, options: UpdateQueryOptions<TVars>) => TData): void

- Defined in node_modules/apollo-client/core/ObservableQuery.d.ts:67
Type parameters
- TVars = TVariables
Parameters
- mapFn: (previousQueryResult: TData, options: UpdateQueryOptions<TVars>) => TData
  - - (previousQueryResult: TData, options: UpdateQueryOptions<TVars>): TData
    - Parameters
      - previousQueryResult: TData
      - options: UpdateQueryOptions<TVars>
      Returns TData
Returns void

Static from

from<R>(observable: <internal>.Observable<R> | ObservableLike<R> | ArrayLike<R>): <internal>.Observable<R>

Inherited from Observable.from
- Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:8
Type parameters
- R
Parameters
- observable: <internal>.Observable<R> | ObservableLike<R> | ArrayLike<R>
Returns <internal>.Observable<R>

Static of

of<R>(...args: R[]): <internal>.Observable<R>

Inherited from Observable.of
- Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:9
Type parameters
- R
Parameters
- Rest ...args: R[]
Returns <internal>.Observable<R>

Type parameters

TData = any

TVariables = OperationVariables

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

TData = any

TVariables = OperationVariables

Parameters

__namedParameters: { options: WatchQueryOptions<TVariables>; queryManager: QueryManager<any>; shouldSubscribe?: boolean }

options: WatchQueryOptions<TVariables>

queryManager: QueryManager<any>

Optional shouldSubscribe?: boolean

Returns ObservableQuery<TData, TVariables>

Properties

options

Readonly queryId

Optional Readonly queryName

variables

Methods

currentResult

Returns ApolloCurrentResult<TData>

fetchMore

Type parameters

K: string | number | symbol

Parameters

fetchMoreOptions: FetchMoreQueryOptions<TVariables, K> & FetchMoreOptions<TData, TVariables>

Returns Promise<ApolloQueryResult<TData>>

filter

Parameters

fn: (value: ApolloQueryResult<TData>) => boolean

Parameters

value: ApolloQueryResult<TData>

Returns boolean

Returns <internal>.Observable<ApolloQueryResult<TData>>

flatMap

Type parameters

R

Parameters

fn: (value: ApolloQueryResult<TData>) => ObservableLike<R>

Parameters

value: ApolloQueryResult<TData>

Returns ObservableLike<R>

Returns <internal>.Observable<R>

forEach

Parameters

fn: (value: ApolloQueryResult<TData>) => void

Parameters

value: ApolloQueryResult<TData>

Returns void

Returns Promise<void>

from

Type parameters

R

Parameters

observable: <internal>.Observable<R> | ObservableLike<R> | ArrayLike<R>

Returns <internal>.Observable<R>

getCurrentResult

Returns ApolloCurrentQueryResult<TData>

getLastError

Returns ApolloError

getLastResult

Returns ApolloQueryResult<TData>

isDifferentFromLastResult

Parameters

newResult: ApolloQueryResult<TData>

Returns boolean

map

Type parameters

R

Parameters

fn: (value: ApolloQueryResult<TData>) => R

Parameters

value: ApolloQueryResult<TData>

Returns R