{ "schemaVersion": "2.1.0", "modules": [ { "kind": "javascript-module", "path": "apollo-element", "declarations": [ { "name": "ApolloElement", "description": "`ApolloElement`\n* 🚀 Single-operation custom-element base class for apollo lit elements.\n* See [`ApolloElementInterface`](https://apolloelements.dev/api/core/interfaces/element) for more information on events", "superclass": { "name": "LitElement", "package": "lit" }, "members": [ { "name": "controller", "type": { "text": "ApolloController" }, "kind": "field" }, { "name": "readyToReceiveDocument", "type": { "text": "boolean" }, "default": "false", "kind": "field" }, { "name": "loading", "summary": "Whether a request is in flight.", "type": { "text": "boolean" }, "default": "false", "kind": "field", "attribute": "loading", "reflects": true } ], "kind": "class" } ], "exports": [ { "kind": "js", "name": "ApolloElement", "declaration": { "name": "ApolloElement", "module": "apollo-element" } } ] }, { "kind": "javascript-module", "path": "apollo-mutation", "declarations": [ { "name": "ApolloMutation", "description": "`ApolloMutation`\n* 👩‍🚀 Custom element base class to issue mutations via your Apollo cache.\n* See [`ApolloMutationInterface`](https://apolloelements.dev/api/core/interfaces/mutation) for more information on events", "superclass": { "name": "ApolloElement" }, "members": [ { "name": "data", "description": "Latest mutation data.", "type": { "text": "Data | null" }, "kind": "field" }, { "name": "variables", "summary": "Mutation variables.", "description": "An object that maps from the name of a variable as used in the mutation GraphQL document to that variable's value.", "type": { "text": "Variables | null" }, "kind": "field" }, { "name": "controller", "default": "new ApolloMutationController(this, null, {\\n onCompleted: data => this.onCompleted?.(data),\\n onError: error => this.onError?.(error),\\n })", "kind": "field" }, { "name": "called", "summary": "Whether the mutation was called", "type": { "text": "boolean" }, "default": "false", "kind": "field" }, { "name": "mutation", "summary": "The mutation.", "type": { "text": "ComponentDocument | null" }, "default": "null", "kind": "field" }, { "name": "optimisticResponse", "description": "An object that represents the result of this mutation that will be optimistically\nstored before the server has actually returned a result, or a unary function that\ntakes the mutation's variables and returns such an object.\n* This is most often used for optimistic UI, where we want to be able to see\nthe result of a mutation immediately, and update the UI later if any errors\nappear.\n\n
\n
Using a function
\n\n```ts\nelement.optimisticResponse = ({ name }: HelloMutationVariables) => ({\n__typename: 'Mutation',\nhello: {\n__typename: 'Greeting',\nname,\n},\n});\n```\n
", "type": { "text": "OptimisticResponseType" }, "kind": "field" }, { "name": "ignoreResults", "summary": "If true, the returned data property will not update with the mutation result.", "type": { "text": "boolean" }, "default": "false", "kind": "field" }, { "name": "awaitRefetchQueries", "description": "Queries refetched as part of refetchQueries are handled asynchronously,\nand are not waited on before the mutation is completed (resolved).\nSetting this to true will make sure refetched queries are completed\nbefore the mutation is considered done. false by default.", "type": { "text": "boolean" }, "kind": "field" }, { "name": "errorPolicy", "description": "Specifies the ErrorPolicy to be used for this mutation.", "type": { "text": "ErrorPolicy" }, "kind": "field" }, { "name": "fetchPolicy", "description": "Specifies the FetchPolicy to be used for this mutation.", "type": { "text": "'no-cache'" }, "kind": "field" }, { "name": "refetchQueries", "description": "A list of query names which will be refetched once this mutation has returned.\nThis is often used if you have a set of queries which may be affected by a mutation and will have to update.\nRather than writing a mutation query reducer (i.e. `updateQueries`) for this,\nyou can refetch the queries that will be affected\nand achieve a consistent store once these queries return.", "type": { "text": "RefetchQueriesType | null" }, "default": "null", "kind": "field" }, { "name": "fromAttribute", "kind": "method" }, { "name": "updater", "description": "A function which updates the apollo cache when the query responds.\nThis function will be called twice over the lifecycle of a mutation.\nOnce at the very beginning if an optimisticResponse was provided.\nThe writes created from the optimistic data will be rolled back before\nthe second time this function is called which is when the mutation has\nsuccesfully resolved. At that point update will be called with the actual\nmutation result and those writes will not be rolled back.\n* The reason a DataProxy is provided instead of the user calling the methods\ndirectly on ApolloClient is that all of the writes are batched together at\nthe end of the update, and it allows for writes generated by optimistic\ndata to be rolled back.", "type": { "text": "MutationUpdaterFn, Variables>" }, "kind": "field" }, { "parameters": [ { "name": "params", "type": { "text": "Partial, Variables>>" } } ], "return": { "type": { "text": "Promise>>" } }, "name": "mutate", "kind": "method", "privacy": "public" } ], "kind": "class" } ], "exports": [ { "kind": "js", "name": "ApolloMutation", "declaration": { "name": "ApolloMutation", "module": "apollo-mutation" } } ] }, { "kind": "javascript-module", "path": "apollo-query.js", "declarations": [ { "name": "ApolloQuery", "description": "`ApolloQuery`\n* 🚀 Custom element base class that connects to your Apollo cache.\n* See [`ApolloQueryInterface`](https://apolloelements.dev/api/core/interfaces/query) for more information on events", "superclass": { "name": "ApolloElement" }, "members": [ { "name": "data", "description": "Latest query data.", "type": { "text": "Data | null" }, "kind": "field" }, { "name": "variables", "summary": "Query variables.", "description": "An object that maps from the name of a variable as used in the query GraphQL document to that variable's value.", "type": { "text": "Variables | null" }, "kind": "field" }, { "name": "controller", "type": { "text": "ApolloQueryController" }, "default": "new ApolloQueryController(this, null, {\\n shouldSubscribe: options => this.readyToReceiveDocument && this.shouldSubscribe(options),\\n onData: data => this.onData?.(data),\\n onError: error => this.onError?.(error), // covered\\n })", "kind": "field" }, { "parameters": [ { "name": "options", "type": { "text": "Partial, Variables>>" } } ], "return": { "type": { "text": "boolean" } }, "name": "shouldSubscribe", "description": "Determines whether the element should attempt to subscribe i.e. begin querying\nOverride to prevent subscribing unless your conditions are met", "kind": "method" }, { "name": "options", "type": { "text": "ApolloQueryControllerOptions" }, "kind": "field", "description": "| Option | Type | Description |\n| --------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| fetchPolicy | `WatchQueryFetchPolicy`{lang=ts} | The [fetchPolicy](https://www.apollographql.com/docs/react/api/core/ApolloClient/#FetchPolicy) for the query. |\n| variables | `Variables`{lang=ts} | Variables for the query. |\n| noAutoSubscribe | `boolean`{lang=ts} | If true, the element will not begin querying data until you manually call `subscribe` |\n| shouldSubscribe | `(op?: Partial>) => boolean`{lang=ts} | Determines whether the element should attempt to subscribe automatically\\\\nOverride to prevent subscribing unless your conditions are met |\n| onData | `(data: Data) => void`{lang=ts} | Optional callback for when a query resolves. |\n| onError | `(error: Error) => void`{lang=ts} | Optional callback for when an error occurs. |\n\nInherits from [ApolloControllerOptions](/api/core/controllers/controller/#options)" }, { "name": "partialRefetch", "summary": "Set to retry any partial query results.", "description": "If true, perform a query refetch if the query result is marked as being partial,\nand the returned data is reset to an empty Object by the Apollo Client QueryManager\n(due to a cache miss).\n* The default value is false for backwards-compatibility's sake,\nbut should be changed to true for most use-cases.", "type": { "text": "boolean" }, "kind": "field" }, { "name": "pollInterval", "summary": "The time interval (in milliseconds) on which this query should be refetched from the server.", "type": { "text": "number" }, "kind": "field" }, { "name": "returnPartialData", "description": "Opt into receiving partial results from the cache for queries\nthat are not fully satisfied by the cache.", "type": { "text": "boolean" }, "kind": "field" }, { "name": "noAutoSubscribe", "description": "When true, the component will not automatically subscribe to new data.\nCall the `subscribe()` method to do so.", "type": { "text": "boolean" }, "default": "false", "kind": "field" }, { "name": "notifyOnNetworkStatusChange", "summary": "Whether or not updates to the network status should trigger next on the observer of this query.", "type": { "text": "boolean" }, "kind": "field" }, { "name": "errorPolicy", "summary": "[Error Policy](https://www.apollographql.com/docs/react/api/core/ApolloClient/#ErrorPolicy) for the query.", "description": "errorPolicy determines the level of events for errors in the execution result. The options are:\n- `none` (default): any errors from the request are treated like runtime errors and the observable is stopped (XXX this is default to lower breaking changes going from AC 1.0 => 2.0)\n- `ignore`: errors from the request do not stop the observable, but also don't call `next`\n- `all`: errors are treated like data and will notify observables", "type": { "text": "C.ErrorPolicy" }, "kind": "field" }, { "name": "fetchPolicy", "summary": "The [fetchPolicy](https://www.apollographql.com/docs/react/api/core/ApolloClient/#FetchPolicy) for the query.", "description": "Determines where the client may return a result from. The options are:\n* - `cache-first` (default): return result from cache, fetch from network if cached result is not available.\n- `cache-and-network`: return result from cache first (if it exists), then return network result once it's available.\n- `cache-only`: return result from cache if available, fail otherwise.\n- `no-cache`: return result from network, fail if network call doesn't succeed, don't save to cache\n- `network-only`: return result from network, fail if network call doesn't succeed, save to cache\n- `standby`: only for queries that aren't actively watched, but should be available for refetch and updateQueries.", "type": { "text": "C.WatchQueryFetchPolicy" }, "kind": "field" }, { "name": "nextFetchPolicy", "summary": "Set to prevent subsequent network requests when the fetch policy is `cache-and-network` or `network-only`.", "description": "When someone chooses cache-and-network or network-only as their\ninitial FetchPolicy, they often do not want future cache updates to\ntrigger unconditional network requests, which is what repeatedly\napplying the cache-and-network or network-only policies would seem\nto imply. Instead, when the cache reports an update after the\ninitial network request, it may be desirable for subsequent network\nrequests to be triggered only if the cache result is incomplete.\nThe nextFetchPolicy option provides a way to update\noptions.fetchPolicy after the intial network request, without\nhaving to set options.", "type": { "text": "this['controller']['options']['nextFetchPolicy']" }, "kind": "field" }, { "parameters": [ { "name": "variables", "type": { "text": "Variables" } } ], "name": "refetch", "description": "Exposes the [`ObservableQuery#refetch`](https://www.apollographql.com/docs/react/api/apollo-client.html#ObservableQuery.refetch) method.", "kind": "method", "privacy": "public" }, { "parameters": [ { "name": "params", "type": { "text": "Partial, Variables>>" } } ], "return": { "type": { "text": "Subscription" } }, "name": "subscribe", "description": "Resets the observableQuery and subscribes.", "kind": "method", "privacy": "public" }, { "parameters": [ { "name": "options", "type": { "text": "C.ObservableQuery.SubscribeToMoreOptions, TSubscriptionVariables, TSubscriptionData, Variables>" } } ], "return": { "type": { "text": "(() => void) | void" } }, "name": "subscribeToMore", "description": "Lets you pass a GraphQL subscription and updateQuery function\nto subscribe to more updates for your query.\n* The `updateQuery` parameter is a function that takes the previous query data,\nthen a `{ subscriptionData: TSubscriptionResult }` object,\nand returns an object with updated query data based on the new results.", "kind": "method", "privacy": "public" }, { "parameters": [ { "name": "params", "type": { "text": "Partial, Variables>>" } } ], "return": { "type": { "text": "Promise>>" } }, "name": "executeQuery", "description": "Executes a Query once and updates the with the result", "kind": "method", "privacy": "public" }, { "parameters": [ { "name": "params", "type": { "text": "Partial>" } } ], "return": { "type": { "text": "Promise>>" } }, "name": "fetchMore", "description": "Exposes the `ObservableQuery#fetchMore` method.\nhttps://www.apollographql.com/docs/react/api/core/ObservableQuery/#ObservableQuery.fetchMore\n* The optional `updateQuery` parameter is a function that takes the previous query data,\nthen a `{ subscriptionData: TSubscriptionResult }` object,\nand returns an object with updated query data based on the new results.\n* The optional `variables` parameter is an optional new variables object.", "kind": "method", "privacy": "public" }, { "parameters": [ { "name": "ms", "type": { "text": "number" } } ], "return": { "type": { "text": "void" } }, "name": "startPolling", "kind": "method", "privacy": "public" }, { "return": { "type": { "text": "void" } }, "name": "stopPolling", "kind": "method", "privacy": "public" } ], "kind": "class" } ], "exports": [ { "kind": "js", "name": "ApolloQuery", "declaration": { "name": "ApolloQuery", "module": "apollo-query.js" } } ] }, { "kind": "javascript-module", "path": "apollo-subscription", "declarations": [ { "name": "ApolloSubscription", "description": "`ApolloSubscription`\n* 🚀 LitElement base class that updates with an Apollo GraphQL subscription.\n* See [`ApolloSubscriptionInterface`](https://apolloelements.dev/api/core/interfaces/subscription) for more information on events", "superclass": { "name": "ApolloElement" }, "members": [ { "name": "is", "type": { "text": "string" }, "default": "'apollo-subscription'", "readonly": true, "kind": "field", "static": true }, { "name": "canAutoSubscribe", "summary": "Flags an element that's ready and able to auto subscribe", "type": { "text": "boolean" }, "readonly": true, "kind": "field" }, { "name": "noAutoSubscribe", "summary": "If true, the element will not begin querying data until you manually call `subscribe`", "type": { "text": "boolean" }, "default": "false", "kind": "field" }, { "name": "notifyOnNetworkStatusChange", "summary": "Whether or not updates to the network status should trigger next on the observer of this subscription.", "type": { "text": "boolean" }, "kind": "field" }, { "name": "shouldResubscribe", "summary": "Determines if your subscription should be unsubscribed and subscribed again.", "type": { "text": "boolean" }, "default": "false", "kind": "field" }, { "name": "skip", "summary": "If true, the query will be skipped entirely", "type": { "text": "boolean" }, "default": "false", "kind": "field" }, { "name": "errorPolicy", "summary": "Error policy for the subscription", "type": { "text": "C.ErrorPolicy" }, "kind": "field" }, { "name": "fetchPolicy", "summary": "Specifies the FetchPolicy to be used for this subscription.", "type": { "text": "C.FetchPolicy" }, "kind": "field" }, { "name": "pollInterval", "summary": "The time interval (in milliseconds) on which this subscription should be refetched from the server.", "type": { "text": "number" }, "kind": "field" }, { "parameters": [ { "name": "args", "type": { "text": "Parameters" }, "rest": true } ], "return": { "type": { "text": "void" } }, "name": "subscribe", "summary": "Resets the observable and subscribes.", "kind": "method" }, { "return": { "type": { "text": "void" } }, "name": "cancel", "summary": "Cancels and clears the subscription", "kind": "method" }, { "parameters": [ { "name": "options", "type": { "text": "Partial, Variables>>" } } ], "return": { "type": { "text": "boolean" } }, "name": "shouldSubscribe", "description": "Determines whether the element should attempt to subscribe automatically\nOverride to prevent subscribing unless your conditions are met", "kind": "method" } ], "kind": "class" } ], "exports": [ { "kind": "js", "name": "ApolloSubscription", "declaration": { "name": "ApolloSubscription", "module": "apollo-subscription" } } ] }, { "kind": "javascript-module", "path": "index" } ] }