Class ApolloCache<TSerialized> Abstract

Type Parameters

TSerialized

Hierarchy

ApolloCache

Implements

DataProxy

Constructors

constructor

new ApolloCache<TSerialized>(): ApolloCache<TSerialized>

Type Parameters
- TSerialized
Returns ApolloCache<TSerialized>

Properties

Private getFragmentDoc

getFragmentDoc: any

Methods

batch

batch<U>(options: BatchOptions<ApolloCache<TSerialized>, U>): U

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:16
Type Parameters
- U
Parameters
- options: BatchOptions<ApolloCache<TSerialized>, U>
Returns U

Abstract diff

diff<T>(query: DiffOptions<any, any>): DiffResult<T>

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:9
Type Parameters
- T
Parameters
- query: DiffOptions<any, any>
Returns DiffResult<T>

Abstract evict

evict(options: EvictOptions): boolean

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:12
Parameters
- options: EvictOptions
Returns boolean

Abstract extract

extract(optimistic?: boolean): TSerialized

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:14
Parameters
- Optional optimistic: boolean
Returns TSerialized

gc

gc(): string[]

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:22
Returns string[]

identify

identify(object: Reference | StoreObject): undefined | string

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:21
Parameters
- object: Reference | StoreObject
Returns undefined | string

modify

modify(options: ModifyOptions): boolean

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:23
Parameters
- options: ModifyOptions
Returns boolean

Abstract performTransaction

performTransaction(transaction: Transaction<TSerialized>, optimisticId?: null | string): void

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:17
Parameters
- transaction: Transaction<TSerialized>
- Optional optimisticId: null | string
Returns void

Abstract read

read<TData, TVariables>(query: ReadOptions<TVariables, TData>): null | TData

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:7
Type Parameters
- TData = any
- TVariables = any
Parameters
- query: ReadOptions<TVariables, TData>
Returns null | TData

readFragment

readFragment<FragmentType, TVariables>(options: ReadFragmentOptions<FragmentType, TVariables>, optimistic?: boolean): null | FragmentType

Implementation of DataProxy.readFragment
- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:26
Type Parameters
- FragmentType
- TVariables = any
Parameters
- options: ReadFragmentOptions<FragmentType, TVariables>
- Optional optimistic: boolean
Returns null | FragmentType

readQuery

readQuery<QueryType, TVariables>(options: ReadQueryOptions<QueryType, TVariables>, optimistic?: boolean): null | QueryType

Implementation of DataProxy.readQuery
- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:24
Type Parameters
- QueryType
- TVariables = any
Parameters
- options: ReadQueryOptions<QueryType, TVariables>
- Optional optimistic: boolean
Returns null | QueryType

recordOptimisticTransaction

recordOptimisticTransaction(transaction: Transaction<TSerialized>, optimisticId: string): void

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:18
Parameters
- transaction: Transaction<TSerialized>
- optimisticId: string
Returns void

Abstract removeOptimistic

removeOptimistic(id: string): void

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:15
Parameters
- id: string
Returns void

Abstract reset

reset(options?: ResetOptions): internal.Promise<void>

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:11
Parameters
- Optional options: ResetOptions
Returns internal.Promise<void>

Abstract restore

restore(serializedState: TSerialized): ApolloCache<TSerialized>

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:13
Parameters
- serializedState: TSerialized
Returns ApolloCache<TSerialized>

transformDocument

transformDocument(document: DocumentNode): DocumentNode

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:19
Parameters
- document: DocumentNode
Returns DocumentNode

transformForLink

transformForLink(document: DocumentNode): DocumentNode

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:20
Parameters
- document: DocumentNode
Returns DocumentNode

updateFragment

updateFragment<TData, TVariables>(options: UpdateFragmentOptions<TData, TVariables>, update: ((data: null | TData) => null | void | TData)): null | TData

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:30
Type Parameters
- TData = any
- TVariables = any
Parameters
- options: UpdateFragmentOptions<TData, TVariables>
- update: ((data: null | TData) => null | void | TData)
  - - (data: null | TData): null | void | TData
    - Parameters
      - data: null | TData
      Returns null | void | TData
Returns null | TData

updateQuery

updateQuery<TData, TVariables>(options: UpdateQueryOptions<TData, TVariables>, update: ((data: null | TData) => null | void | TData)): null | TData

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:29
Type Parameters
- TData = any
- TVariables = any
Parameters
- options: UpdateQueryOptions<TData, TVariables>
- update: ((data: null | TData) => null | void | TData)
  - - (data: null | TData): null | void | TData
    - Parameters
      - data: null | TData
      Returns null | void | TData
Returns null | TData

Abstract watch

watch<TData, TVariables>(watch: WatchOptions<TData, TVariables>): (() => void)

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:10
Type Parameters
- TData = any
- TVariables = any
Parameters
- watch: WatchOptions<TData, TVariables>
Returns (() => void)
- - (): void
  - Returns void

Abstract write

write<TData, TVariables>(write: WriteOptions<TData, TVariables>): undefined | Reference

- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:8
Type Parameters
- TData = any
- TVariables = any
Parameters
- write: WriteOptions<TData, TVariables>
Returns undefined | Reference

writeFragment

writeFragment<TData, TVariables>(__namedParameters: WriteFragmentOptions<TData, TVariables>): undefined | Reference

Implementation of DataProxy.writeFragment
- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:28
Type Parameters
- TData = any
- TVariables = any
Parameters
- __namedParameters: WriteFragmentOptions<TData, TVariables>
Returns undefined | Reference

writeQuery

writeQuery<TData, TVariables>(__namedParameters: WriteQueryOptions<TData, TVariables>): undefined | Reference

Implementation of DataProxy.writeQuery
- Defined in node_modules/@apollo/client/cache/core/cache.d.ts:27
Type Parameters
- TData = any
- TVariables = any
Parameters
- __namedParameters: WriteQueryOptions<TData, TVariables>
Returns undefined | Reference

Generated using TypeDoc