This repository has been archived by the owner on Apr 17, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
776 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
138 changes: 138 additions & 0 deletions
138
website/versioned_docs/version-0.14.0/ref-configuration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| --- | ||
| id: version-0.14.0-client-configuration | ||
| title: Client Configuration | ||
| sidebar_label: Client Configuration | ||
| original_id: client-configuration | ||
| --- | ||
|
|
||
| ## offix-client | ||
|
|
||
| ### `ApolloOfflineClient` | ||
|
|
||
| `ApolloOfflineClient` extends the `ApolloClient` class. Check the [`ApolloClient` constructor docs](https://www.apollographql.com/docs/react/v2.5/api/apollo-client/#apolloclient) to see the options that can be passed. | ||
|
|
||
| There are some additional options specific to `ApolloOfflineClient`. | ||
|
|
||
| #### `networkStatus` | ||
|
|
||
| [NetworkStatus](https://github.com/aerogear/offix/blob/master/packages/offix-offline/src/network/NetworkStatus.ts) Interface for detecting changes in network status. (Uses browser networking APIs by default) | ||
|
|
||
| #### `offlineStorage` | ||
|
|
||
| The [PersistentStore](https://github.com/aerogear/offix/blob/master/packages/offix-scheduler/src/store/PersistentStore.ts) you want your client to use for persisting offline operations in the offline queue (Uses IndexedDB by default). | ||
|
|
||
| #### `cacheStorage` | ||
|
|
||
| The [PersistentStore](https://github.com/aerogear/offix/blob/master/packages/offix-scheduler/src/store/PersistentStore.ts) you want your client to use for persisting the Apollo Cache (Uses IndexedDB by default). | ||
|
|
||
| #### `cachePersistor` | ||
|
|
||
| The [CachePersistor](https://github.com/apollographql/apollo-cache-persist#using-cachepersistor) instance used by the client to persist the Apollo Cache across application restarts. Pass your own instance to override the one that is created by default. | ||
|
|
||
| Example: | ||
|
|
||
| ```js | ||
| import { ApolloOfflineClient, createDefaultCacheStorage } from "offix-client"; | ||
| import { HttpLink } from "apollo-link-http"; | ||
| import { InMemoryCache } from "apollo-cache-inmemory"; | ||
| import { CachePersistor } from "apollo-cache-persist"; | ||
|
|
||
| const link = new HttpLink({ uri: "http://example.com/graphql" }); | ||
| const cache = new InMemoryCache() | ||
|
|
||
| const cachePersistor = new CachePersistor({ | ||
| cache, | ||
| storage: createDefaultCacheStorage() | ||
| }) | ||
|
|
||
| const client = new ApolloOfflineClient({ | ||
| cache, | ||
| cachePersistor, | ||
| link | ||
| }); | ||
| ``` | ||
|
|
||
| Note: if using TypeScript, you may need to declare the cachePersistor as follows `const cachePersistor = new CachePersistor<object>(...options)` or you may experience compiler errors. | ||
|
|
||
| This example uses `createDefaultCacheStorage` to create the default IndexedDB based storage driver. | ||
| The storage can be swapped depending on the platform. For example `window.localstorage` in older browsers or `AsyncStorage` in [React Native](./react-native.md). | ||
|
|
||
|
|
||
| #### `offlineQueueListener` | ||
|
|
||
| [ApolloOfflineQueueListener](./ref-offline.md#listening-for-events) User provided listener that contains a set of methods that are called when certain events occur in the queue. | ||
|
|
||
| #### `conflictProvider` | ||
|
|
||
| [ObjectState](./ref-conflict-server.md#implementing-custom-conflict-resolution) Interface that defines how object state is progressed. This interface needs to match state provider supplied on server. | ||
|
|
||
| #### `conflictStrategy` | ||
|
|
||
| [ConflictResolutionStrategy](https://github.com/aerogear/offix/blob/master/packages/offix-conflicts-client/src/strategies/ConflictResolutionStrategy.ts)interface used on the client to resolve conflicts. The [default strategy](https://github.com/aerogear/offix/blob/master/packages/offix-conflicts-client/src/strategies/strategies.ts) merges client changes onto the server changes. | ||
|
|
||
| #### `mutationCacheUpdates` | ||
|
|
||
| [CacheUpdates](./ref-offline.md#global-update-functions) Cache updates functions for your mutations. Argument allows to restore optimistic responses on application restarts. | ||
|
|
||
| #### `retryOptions` | ||
|
|
||
| The options to configure how failed offline mutations are retried. See [`apollo-link-retry`](https://www.apollographql.com/docs/link/links/retry/). | ||
|
|
||
| #### `inputMapper` | ||
|
|
||
| If your mutation variables are not passed directly, for example if you use input types, an `inputMapper` is a set of functions that tells Offix how to read the mutation `variables`. | ||
|
|
||
| For example, if your mutations use Input types: | ||
|
|
||
| ```js | ||
| const CREATE_TASK = gql` | ||
| mutation createTask($input: TaskInput!) { | ||
| createTask(input: $input) { | ||
| id | ||
| title | ||
| description | ||
| } | ||
| }` | ||
|
|
||
| client.offlineMutate({ | ||
| mutation: CREATE_TASK, | ||
| variables: { | ||
| input: { | ||
| title: 'new task title', | ||
| description: 'new task description' | ||
| } | ||
| }, | ||
| returnType: 'Task' | ||
| }) | ||
| ``` | ||
|
|
||
| `ApolloOfflineClient` will need an additional `inputMapper` object with the following functions: | ||
|
|
||
| * `deserialize` - to know how to convert the `variables` object into a flat object that can be used to generate optimistic responses and cache update functions. | ||
| * `serialize` - to know how to convert the serialized object back into the correct `variables` object after performing conflict resolution. | ||
|
|
||
| ```js | ||
| import { ApolloOfflineClient, createDefaultCacheStorage } from "offix-client"; | ||
|
|
||
| const client = new ApolloOfflineClient({ | ||
| cache: new InMemoryCache(), | ||
| link: new HttpLink({ uri: "http://example.com/graphql" }), | ||
| inputMapper: { | ||
| deserialize: (variables) => { return variables.input }, | ||
| serialize: (variables) => { return { input: variables } } | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| ## offix-client-boost | ||
|
|
||
| ### `createClient` | ||
|
|
||
| `createClient` accepts all of the `ApolloOfflineClient` options described above as well as the ones listed below. | ||
|
|
||
| * `httpUrl` (required) - The URL of the GraphQL server | ||
| * `wsUrl` (required) - The URL of the websocket endpoint for subscriptions | ||
| * `cache` - The Apollo [InMemoryCache](https://www.apollographql.com/docs/react/caching/cache-configuration/) that will be used. (creates one by default). | ||
| * `authContextProvider` - An object or an `async` function that returns an [`AuthContext`](https://github.com/aerogear/offix/blob/master/packages/offix-client-boost/src/auth/AuthContexrProvider.ts) object with authentication headers that will be passed in GraphQL requests and in the `connectionParams` of websocket connections. | ||
| * `fileUpload` - If set to `true`, GraphGL file uploads will be enabled and supported. (default is `false`) | ||
| * `websocketClientOptions` - Options for the websocket client used for subscriptions. See [subscriptions-transport-ws](https://www.npmjs.com/package/subscriptions-transport-ws) |
Oops, something went wrong.