QueryManager | helyOS-JavaScript-SDK

Type parameters

TStore

Hierarchy

QueryManager

Constructors

constructor

new QueryManager<TStore>(__namedParameters: { assumeImmutableResults?: boolean; clientAwareness?: Record<string, string>; link: ApolloLink; localState?: LocalState<TStore>; queryDeduplication?: boolean; ssrMode?: boolean; store: DataStore<TStore>; onBroadcast?: any }): QueryManager<TStore>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:36
Type parameters
- TStore
Parameters
- __namedParameters: { assumeImmutableResults?: boolean; clientAwareness?: Record<string, string>; link: ApolloLink; localState?: LocalState<TStore>; queryDeduplication?: boolean; ssrMode?: boolean; store: DataStore<TStore>; onBroadcast?: any }
  - Optional assumeImmutableResults?: boolean
  - Optional clientAwareness?: Record<string, string>
  - link: ApolloLink
  - Optional localState?: LocalState<TStore>
  - Optional queryDeduplication?: boolean
  - Optional ssrMode?: boolean
  - store: DataStore<TStore>
  - onBroadcast?:function
    - onBroadcast(): void
    - Defined in node_modules/apollo-client/core/QueryManager.d.ts:40
      Returns void
Returns QueryManager<TStore>

Properties

Readonly assumeImmutableResults

assumeImmutableResults: boolean

dataStore

dataStore: DataStore<TStore>

link

link: ApolloLink

mutationStore

mutationStore: MutationStore

queryStore

queryStore: QueryStore

Methods

addObservableQuery

addObservableQuery<T>(queryId: string, observableQuery: ObservableQuery<T, OperationVariables>): void

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:68
Type parameters
- T
Parameters
- queryId: string
- observableQuery: ObservableQuery<T, OperationVariables>
Returns void

addQueryListener

addQueryListener(queryId: string, listener: QueryListener): void

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:66
Parameters
- queryId: string
- listener: QueryListener
Returns void

broadcastQueries

broadcastQueries(): void

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:88
Returns void

checkInFlight

checkInFlight(queryId: string): boolean

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:97
Parameters
- queryId: string
Returns boolean

clearStore

clearStore(): Promise<void>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:70
Returns Promise<void>

fetchQuery

fetchQuery<T>(queryId: string, options: WatchQueryOptions<OperationVariables>, fetchType?: FetchType, fetchMoreForQueryId?: string): Promise<FetchResult<T, Record<string, any>, Record<string, any>>>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:48
Type parameters
- T
Parameters
- queryId: string
- options: WatchQueryOptions<OperationVariables>
- Optional fetchType: FetchType
- Optional fetchMoreForQueryId: string
Returns Promise<FetchResult<T, Record<string, any>, Record<string, any>>>

generateQueryId

generateQueryId(): string

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:63
Returns string

getCurrentQueryResult

getCurrentQueryResult<T>(observableQuery: ObservableQuery<T, OperationVariables>, optimistic?: boolean): { data: T; partial: boolean }

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:79
Type parameters
- T
Parameters
- observableQuery: ObservableQuery<T, OperationVariables>
- Optional optimistic: boolean
Returns { data: T; partial: boolean }
- data: T
- partial: boolean

getLocalState

getLocalState(): LocalState<TStore>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:89
Returns LocalState<TStore>

getQueryWithPreviousResult

getQueryWithPreviousResult<TData, TVariables>(queryIdOrObservable: string | ObservableQuery<TData, TVariables>): { document: DocumentNode; previousResult: any; variables: TVariables }

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:83
Type parameters
- TData
- TVariables = OperationVariables
Parameters
- queryIdOrObservable: string | ObservableQuery<TData, TVariables>
Returns { document: DocumentNode; previousResult: any; variables: TVariables }
- document: DocumentNode
- previousResult: any
- variables: TVariables

mutate

mutate<T>(__namedParameters: MutationOptions<{}, OperationVariables>): Promise<FetchResult<T, Record<string, any>, Record<string, any>>>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:47
Type parameters
- T
Parameters
- __namedParameters: MutationOptions<{}, OperationVariables>
Returns Promise<FetchResult<T, Record<string, any>, Record<string, any>>>

observeQuery

observeQuery<T>(queryId: string, options: WatchQueryOptions<OperationVariables>, observer: <internal>.Observer<ApolloQueryResult<T>>): Promise<FetchResult<T, Record<string, any>, Record<string, any>>>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:73
Type parameters
- T
Parameters
- queryId: string
- options: WatchQueryOptions<OperationVariables>
- observer: <internal>.Observer<ApolloQueryResult<T>>
Returns Promise<FetchResult<T, Record<string, any>, Record<string, any>>>

query

query<T>(options: QueryOptions<OperationVariables>): Promise<ApolloQueryResult<T>>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:62
Type parameters
- T
Parameters
- options: QueryOptions<OperationVariables>
Returns Promise<ApolloQueryResult<T>>

queryListenerForObserver

queryListenerForObserver<T>(queryId: string, options: WatchQueryOptions<OperationVariables>, observer: <internal>.Observer<ApolloQueryResult<T>>): QueryListener

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:50
Type parameters
- T
Parameters
- queryId: string
- options: WatchQueryOptions<OperationVariables>
- observer: <internal>.Observer<ApolloQueryResult<T>>
Returns QueryListener

reFetchObservableQueries

reFetchObservableQueries(includeStandby?: boolean): Promise<ApolloQueryResult<any>[]>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:72
Parameters
- Optional includeStandby: boolean
Returns Promise<ApolloQueryResult<any>[]>

removeObservableQuery

removeObservableQuery(queryId: string): void

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:69
Parameters
- queryId: string
Returns void

removeQuery

removeQuery(queryId: string): void

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:78
Parameters
- queryId: string
Returns void

resetStore

resetStore(): Promise<ApolloQueryResult<any>[]>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:71
Returns Promise<ApolloQueryResult<any>[]>

startGraphQLSubscription

startGraphQLSubscription<T>(__namedParameters: SubscriptionOptions<OperationVariables>): <internal>.Observable<FetchResult<T, Record<string, any>, Record<string, any>>>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:75
Type parameters
- T = any
Parameters
- __namedParameters: SubscriptionOptions<OperationVariables>
Returns <internal>.Observable<FetchResult<T, Record<string, any>, Record<string, any>>>

startPollingQuery

startPollingQuery(options: WatchQueryOptions<OperationVariables>, queryId: string, listener?: QueryListener): string

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:99
Parameters
- options: WatchQueryOptions<OperationVariables>
- queryId: string
- Optional listener: QueryListener
Returns string

startQuery

startQuery<T>(queryId: string, options: WatchQueryOptions<OperationVariables>, listener: QueryListener): string

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:74
Type parameters
- T
Parameters
- queryId: string
- options: WatchQueryOptions<OperationVariables>
- listener: QueryListener
Returns string

stop

stop(): void

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:46
Returns void

stopPollingQuery

stopPollingQuery(queryId: string): void

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:100
Parameters
- queryId: string
Returns void

stopQuery

stopQuery(queryId: string): void

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:76
Parameters
- queryId: string
Returns void

stopQueryInStore

stopQueryInStore(queryId: string): void

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:64
Parameters
- queryId: string
Returns void

transform

transform(document: DocumentNode): Readonly<{ clientQuery: Readonly<DocumentNode>; defaultVars: Readonly<OperationVariables>; document: Readonly<DocumentNode>; hasClientExports: boolean; hasForcedResolvers: boolean; serverQuery: Readonly<DocumentNode> }>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:52
Parameters
- document: DocumentNode
Returns Readonly<{ clientQuery: Readonly<DocumentNode>; defaultVars: Readonly<OperationVariables>; document: Readonly<DocumentNode>; hasClientExports: boolean; hasForcedResolvers: boolean; serverQuery: Readonly<DocumentNode> }>

updateQueryWatch

updateQueryWatch(queryId: string, document: DocumentNode, options: WatchQueryOptions<OperationVariables>): () => void

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:67
Parameters
- queryId: string
- document: DocumentNode
- options: WatchQueryOptions<OperationVariables>
Returns () => void
- - (): void
  - Returns void

watchQuery

watchQuery<T, TVariables>(options: WatchQueryOptions<OperationVariables>, shouldSubscribe?: boolean): ObservableQuery<T, TVariables>

- Defined in node_modules/apollo-client/core/QueryManager.d.ts:61
Type parameters
- T
- TVariables = OperationVariables
Parameters
- options: WatchQueryOptions<OperationVariables>
- Optional shouldSubscribe: boolean
Returns ObservableQuery<T, TVariables>

Type parameters

TStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

TStore

Parameters

__namedParameters: { assumeImmutableResults?: boolean; clientAwareness?: Record<string, string>; link: ApolloLink; localState?: LocalState<TStore>; queryDeduplication?: boolean; ssrMode?: boolean; store: DataStore<TStore>; onBroadcast?: any }

Optional assumeImmutableResults?: boolean

Optional clientAwareness?: Record<string, string>

link: ApolloLink

Optional localState?: LocalState<TStore>

Optional queryDeduplication?: boolean

Optional ssrMode?: boolean

store: DataStore<TStore>

onBroadcast?:function

Returns void

Returns QueryManager<TStore>

Properties

Readonly assumeImmutableResults

dataStore

link

mutationStore

queryStore

Methods

addObservableQuery

Type parameters

T

Parameters

queryId: string

observableQuery: ObservableQuery<T, OperationVariables>

Returns void

addQueryListener

Parameters

queryId: string

listener: QueryListener

Returns void

broadcastQueries

Returns void

checkInFlight

Parameters

queryId: string

Returns boolean

clearStore

Returns Promise<void>

fetchQuery

Type parameters

T

Parameters

queryId: string

options: WatchQueryOptions<OperationVariables>

Optional fetchType: FetchType

Optional fetchMoreForQueryId: string

Returns Promise<FetchResult<T, Record<string, any>, Record<string, any>>>

generateQueryId

Returns string

getCurrentQueryResult

Type parameters

T

Parameters

observableQuery: ObservableQuery<T, OperationVariables>

Optional optimistic: boolean

Returns { data: T; partial: boolean }

data: T

partial: boolean

getLocalState

Returns LocalState<TStore>

getQueryWithPreviousResult

Type parameters

TData

TVariables = OperationVariables

Parameters

queryIdOrObservable: string | ObservableQuery<TData, TVariables>

Returns { document: DocumentNode; previousResult: any; variables: TVariables }

document: DocumentNode