Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

deprecate canonizeResults #11435

Merged
merged 3 commits into from
Dec 18, 2023
Merged

deprecate canonizeResults #11435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
59b6ed0
deprecate `canonizeResults`
phryneas Dec 18, 2023
406d05d
remove option from docs page
phryneas Dec 18, 2023
f3f7898
api-extractor
phryneas Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .api-reports/api-report-cache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ namespace Cache_2 {
}
// (undocumented)
interface ReadOptions<TVariables = any, TData = any> extends DataProxy.Query<TVariables, TData> {
// (undocumented)
// @deprecated (undocumented)
canonizeResults?: boolean;
// (undocumented)
optimistic: boolean;
Expand Down Expand Up @@ -234,12 +234,14 @@ export namespace DataProxy {
}
// (undocumented)
export interface ReadFragmentOptions<TData, TVariables> extends Fragment<TVariables, TData> {
// @deprecated (undocumented)
canonizeResults?: boolean;
optimistic?: boolean;
returnPartialData?: boolean;
}
// (undocumented)
export interface ReadQueryOptions<TData, TVariables> extends Query<TVariables, TData> {
// @deprecated
canonizeResults?: boolean;
optimistic?: boolean;
returnPartialData?: boolean;
Expand Down Expand Up @@ -580,7 +582,7 @@ export class InMemoryCache extends ApolloCache<NormalizedCacheObject> {

// @public (undocumented)
export interface InMemoryCacheConfig extends ApolloReducerConfig {
// (undocumented)
// @deprecated (undocumented)
canonizeResults?: boolean;
// (undocumented)
fragments?: FragmentRegistryAPI;
Expand Down Expand Up @@ -971,7 +973,7 @@ interface WriteContext extends ReadMergeModifyContext {
// src/cache/inmemory/policies.ts:92:3 - (ae-forgotten-export) The symbol "FragmentMap" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/policies.ts:161:3 - (ae-forgotten-export) The symbol "KeySpecifier" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/policies.ts:161:3 - (ae-forgotten-export) The symbol "KeyArgsFunction" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/types.ts:132:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/types.ts:139:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)

Expand Down
14 changes: 9 additions & 5 deletions .api-reports/api-report-core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ namespace Cache_2 {
}
// (undocumented)
interface ReadOptions<TVariables = any, TData = any> extends DataProxy.Query<TVariables, TData> {
// (undocumented)
// @deprecated (undocumented)
canonizeResults?: boolean;
// (undocumented)
optimistic: boolean;
Expand Down Expand Up @@ -482,12 +482,14 @@ export namespace DataProxy {
}
// (undocumented)
export interface ReadFragmentOptions<TData, TVariables> extends Fragment<TVariables, TData> {
// @deprecated (undocumented)
canonizeResults?: boolean;
optimistic?: boolean;
returnPartialData?: boolean;
}
// (undocumented)
export interface ReadQueryOptions<TData, TVariables> extends Query<TVariables, TData> {
// @deprecated
canonizeResults?: boolean;
optimistic?: boolean;
returnPartialData?: boolean;
Expand Down Expand Up @@ -1101,7 +1103,7 @@ export class InMemoryCache extends ApolloCache<NormalizedCacheObject> {

// @public (undocumented)
export interface InMemoryCacheConfig extends ApolloReducerConfig {
// (undocumented)
// @deprecated (undocumented)
canonizeResults?: boolean;
// Warning: (ae-forgotten-export) The symbol "FragmentRegistryAPI" needs to be exported by the entry point index.d.ts
//
Expand Down Expand Up @@ -1827,6 +1829,7 @@ class QueryManager<TStore> {

// @public
interface QueryOptions<TVariables = OperationVariables, TData = any> {
// @deprecated (undocumented)
canonizeResults?: boolean;
context?: DefaultContext;
errorPolicy?: ErrorPolicy;
Expand Down Expand Up @@ -2154,6 +2157,7 @@ export type WatchQueryFetchPolicy = FetchPolicy | "cache-and-network";

// @public
export interface WatchQueryOptions<TVariables extends OperationVariables = OperationVariables, TData = any> {
// @deprecated (undocumented)
canonizeResults?: boolean;
context?: DefaultContext;
errorPolicy?: ErrorPolicy;
Expand Down Expand Up @@ -2208,14 +2212,14 @@ interface WriteContext extends ReadMergeModifyContext {
// src/cache/inmemory/policies.ts:92:3 - (ae-forgotten-export) The symbol "FragmentMap" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/policies.ts:161:3 - (ae-forgotten-export) The symbol "KeySpecifier" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/policies.ts:161:3 - (ae-forgotten-export) The symbol "KeyArgsFunction" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/types.ts:132:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/types.ts:139:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts
// src/core/ObservableQuery.ts:113:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
// src/core/ObservableQuery.ts:114:5 - (ae-forgotten-export) The symbol "QueryInfo" needs to be exported by the entry point index.d.ts
// src/core/QueryManager.ts:124:5 - (ae-forgotten-export) The symbol "MutationStoreValue" needs to be exported by the entry point index.d.ts
// src/core/QueryManager.ts:158:5 - (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
// src/core/QueryManager.ts:399:7 - (ae-forgotten-export) The symbol "UpdateQueries" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:261:2 - (ae-forgotten-export) The symbol "UpdateQueryFn" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:310:3 - (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:277:3 - (ae-forgotten-export) The symbol "UpdateQueryFn" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:316:3 - (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts
// src/link/http/selectHttpOptionsAndBody.ts:128:32 - (ae-forgotten-export) The symbol "HttpQueryOptions" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)
Expand Down
13 changes: 9 additions & 4 deletions .api-reports/api-report-react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ namespace Cache_2 {
}
// (undocumented)
interface ReadOptions<TVariables = any, TData = any> extends DataProxy.Query<TVariables, TData> {
// (undocumented)
// @deprecated (undocumented)
canonizeResults?: boolean;
// (undocumented)
optimistic: boolean;
Expand Down Expand Up @@ -582,6 +582,7 @@ namespace DataProxy {
//
// (undocumented)
interface ReadFragmentOptions<TData, TVariables> extends Fragment<TVariables, TData> {
// @deprecated (undocumented)
canonizeResults?: boolean;
optimistic?: boolean;
returnPartialData?: boolean;
Expand All @@ -590,6 +591,7 @@ namespace DataProxy {
//
// (undocumented)
interface ReadQueryOptions<TData, TVariables> extends Query<TVariables, TData> {
// @deprecated
canonizeResults?: boolean;
optimistic?: boolean;
returnPartialData?: boolean;
Expand Down Expand Up @@ -1053,6 +1055,7 @@ export type LoadableQueryHookFetchPolicy = Extract<WatchQueryFetchPolicy, "cache

// @public (undocumented)
export interface LoadableQueryHookOptions {
// @deprecated (undocumented)
canonizeResults?: boolean;
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@apollo/client" does not have an export "ApolloClient"
client?: ApolloClient<any>;
Expand Down Expand Up @@ -1699,6 +1702,7 @@ class QueryManager<TStore> {

// @public
interface QueryOptions<TVariables = OperationVariables, TData = any> {
// @deprecated (undocumented)
canonizeResults?: boolean;
context?: Context;
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@apollo/client" does not have an export "ErrorPolicy"
Expand Down Expand Up @@ -2292,6 +2296,7 @@ type WatchQueryFetchPolicy = FetchPolicy | "cache-and-network";

// @public
interface WatchQueryOptions<TVariables extends OperationVariables = OperationVariables, TData = any> {
// @deprecated (undocumented)
canonizeResults?: boolean;
context?: Context;
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@apollo/client" does not have an export "ErrorPolicy"
Expand All @@ -2315,7 +2320,7 @@ interface WatchQueryOptions<TVariables extends OperationVariables = OperationVar

// Warnings were encountered during analysis:
//
// src/cache/core/types/DataProxy.ts:141:5 - (ae-forgotten-export) The symbol "MissingFieldError" needs to be exported by the entry point index.d.ts
// src/cache/core/types/DataProxy.ts:153:5 - (ae-forgotten-export) The symbol "MissingFieldError" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:100:3 - (ae-forgotten-export) The symbol "ReadFieldFunction" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:101:3 - (ae-forgotten-export) The symbol "CanReadFunction" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:102:3 - (ae-forgotten-export) The symbol "isReference" needs to be exported by the entry point index.d.ts
Expand All @@ -2331,8 +2336,8 @@ interface WatchQueryOptions<TVariables extends OperationVariables = OperationVar
// src/core/types.ts:156:3 - (ae-forgotten-export) The symbol "NetworkStatus" needs to be exported by the entry point index.d.ts
// src/core/types.ts:174:3 - (ae-forgotten-export) The symbol "MutationQueryReducer" needs to be exported by the entry point index.d.ts
// src/core/types.ts:201:5 - (ae-forgotten-export) The symbol "Resolver" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:261:2 - (ae-forgotten-export) The symbol "UpdateQueryFn" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:310:3 - (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:277:3 - (ae-forgotten-export) The symbol "UpdateQueryFn" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:316:3 - (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts
// src/react/hooks/useBackgroundQuery.ts:30:3 - (ae-forgotten-export) The symbol "FetchMoreFunction" needs to be exported by the entry point index.d.ts
// src/react/hooks/useBackgroundQuery.ts:31:3 - (ae-forgotten-export) The symbol "RefetchFunction" needs to be exported by the entry point index.d.ts
// src/react/hooks/useLoadableQuery.ts:50:5 - (ae-forgotten-export) The symbol "ResetFunction" needs to be exported by the entry point index.d.ts
Expand Down
12 changes: 8 additions & 4 deletions .api-reports/api-report-react_components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ namespace Cache_2 {
}
// (undocumented)
interface ReadOptions<TVariables = any, TData = any> extends DataProxy.Query<TVariables, TData> {
// (undocumented)
// @deprecated (undocumented)
canonizeResults?: boolean;
// (undocumented)
optimistic: boolean;
Expand Down Expand Up @@ -526,6 +526,7 @@ namespace DataProxy {
//
// (undocumented)
interface ReadFragmentOptions<TData, TVariables> extends Fragment<TVariables, TData> {
// @deprecated (undocumented)
canonizeResults?: boolean;
optimistic?: boolean;
returnPartialData?: boolean;
Expand All @@ -534,6 +535,7 @@ namespace DataProxy {
//
// (undocumented)
interface ReadQueryOptions<TData, TVariables> extends Query<TVariables, TData> {
// @deprecated
canonizeResults?: boolean;
optimistic?: boolean;
returnPartialData?: boolean;
Expand Down Expand Up @@ -1441,6 +1443,7 @@ class QueryManager<TStore> {

// @public
interface QueryOptions<TVariables = OperationVariables, TData = any> {
// @deprecated (undocumented)
canonizeResults?: boolean;
context?: DefaultContext;
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@apollo/client" does not have an export "ErrorPolicy"
Expand Down Expand Up @@ -1720,6 +1723,7 @@ type WatchQueryFetchPolicy = FetchPolicy | "cache-and-network";

// @public
interface WatchQueryOptions<TVariables extends OperationVariables = OperationVariables, TData = any> {
// @deprecated (undocumented)
canonizeResults?: boolean;
context?: DefaultContext;
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@apollo/client" does not have an export "ErrorPolicy"
Expand All @@ -1744,7 +1748,7 @@ interface WatchQueryOptions<TVariables extends OperationVariables = OperationVar

// Warnings were encountered during analysis:
//
// src/cache/core/types/DataProxy.ts:141:5 - (ae-forgotten-export) The symbol "MissingFieldError" needs to be exported by the entry point index.d.ts
// src/cache/core/types/DataProxy.ts:153:5 - (ae-forgotten-export) The symbol "MissingFieldError" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:100:3 - (ae-forgotten-export) The symbol "ReadFieldFunction" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:101:3 - (ae-forgotten-export) The symbol "CanReadFunction" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:102:3 - (ae-forgotten-export) The symbol "isReference" needs to be exported by the entry point index.d.ts
Expand All @@ -1760,8 +1764,8 @@ interface WatchQueryOptions<TVariables extends OperationVariables = OperationVar
// src/core/types.ts:156:3 - (ae-forgotten-export) The symbol "NetworkStatus" needs to be exported by the entry point index.d.ts
// src/core/types.ts:174:3 - (ae-forgotten-export) The symbol "MutationQueryReducer" needs to be exported by the entry point index.d.ts
// src/core/types.ts:201:5 - (ae-forgotten-export) The symbol "Resolver" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:261:2 - (ae-forgotten-export) The symbol "UpdateQueryFn" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:310:3 - (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:277:3 - (ae-forgotten-export) The symbol "UpdateQueryFn" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:316:3 - (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)

Expand Down
12 changes: 8 additions & 4 deletions .api-reports/api-report-react_context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ namespace Cache_2 {
}
// (undocumented)
interface ReadOptions<TVariables = any, TData = any> extends DataProxy.Query<TVariables, TData> {
// (undocumented)
// @deprecated (undocumented)
canonizeResults?: boolean;
// (undocumented)
optimistic: boolean;
Expand Down Expand Up @@ -509,6 +509,7 @@ namespace DataProxy {
//
// (undocumented)
interface ReadFragmentOptions<TData, TVariables> extends Fragment<TVariables, TData> {
// @deprecated (undocumented)
canonizeResults?: boolean;
optimistic?: boolean;
returnPartialData?: boolean;
Expand All @@ -517,6 +518,7 @@ namespace DataProxy {
//
// (undocumented)
interface ReadQueryOptions<TData, TVariables> extends Query<TVariables, TData> {
// @deprecated
canonizeResults?: boolean;
optimistic?: boolean;
returnPartialData?: boolean;
Expand Down Expand Up @@ -1349,6 +1351,7 @@ class QueryManager<TStore> {

// @public
interface QueryOptions<TVariables = OperationVariables, TData = any> {
// @deprecated (undocumented)
canonizeResults?: boolean;
context?: DefaultContext;
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@apollo/client" does not have an export "ErrorPolicy"
Expand Down Expand Up @@ -1616,6 +1619,7 @@ type WatchQueryFetchPolicy = FetchPolicy | "cache-and-network";

// @public
interface WatchQueryOptions<TVariables extends OperationVariables = OperationVariables, TData = any> {
// @deprecated (undocumented)
canonizeResults?: boolean;
context?: DefaultContext;
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@apollo/client" does not have an export "ErrorPolicy"
Expand All @@ -1640,7 +1644,7 @@ interface WatchQueryOptions<TVariables extends OperationVariables = OperationVar

// Warnings were encountered during analysis:
//
// src/cache/core/types/DataProxy.ts:141:5 - (ae-forgotten-export) The symbol "MissingFieldError" needs to be exported by the entry point index.d.ts
// src/cache/core/types/DataProxy.ts:153:5 - (ae-forgotten-export) The symbol "MissingFieldError" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:100:3 - (ae-forgotten-export) The symbol "ReadFieldFunction" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:101:3 - (ae-forgotten-export) The symbol "CanReadFunction" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:102:3 - (ae-forgotten-export) The symbol "isReference" needs to be exported by the entry point index.d.ts
Expand All @@ -1656,8 +1660,8 @@ interface WatchQueryOptions<TVariables extends OperationVariables = OperationVar
// src/core/types.ts:156:3 - (ae-forgotten-export) The symbol "NetworkStatus" needs to be exported by the entry point index.d.ts
// src/core/types.ts:174:3 - (ae-forgotten-export) The symbol "MutationQueryReducer" needs to be exported by the entry point index.d.ts
// src/core/types.ts:201:5 - (ae-forgotten-export) The symbol "Resolver" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:261:2 - (ae-forgotten-export) The symbol "UpdateQueryFn" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:310:3 - (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:277:3 - (ae-forgotten-export) The symbol "UpdateQueryFn" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:316:3 - (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)

Expand Down
Loading
Loading