react-query-gql
Advanced tools
react-query-gql - npm Package Compare versions
Comparing version 0.0.2 to 0.0.3
@@ -5,2 +5,9 @@ # Changelog | ||
| ### [0.0.3](https://github.com/correttojs/graphql-codegen-apollo-next-ssr/compare/v0.0.2...v0.0.3) (2021-05-02) | ||
| ### Features | ||
| * update readme ([00ec32a](https://github.com/correttojs/graphql-codegen-apollo-next-ssr/commit/00ec32ae38020e2326803d72aec5b2fc9a475ab2)) | ||
| ### 0.0.2 (2021-05-02) | ||
@@ -7,0 +14,0 @@ |
| { | ||
| "name": "react-query-gql", | ||
| "version": "0.0.2", | ||
| "version": "0.0.3", | ||
| "description": "React Query Gql Client", | ||
@@ -5,0 +5,0 @@ "license": "MIT", |
@@ -1,54 +0,1 @@ | ||
| # graphql-codegen-apollo-next-ssr | ||
| Generate apollo code for nextjs ssr | ||
| ## Motivations | ||
| Nextjs recently introduced `getServerSideProps` which doesn't allow to use the HOC pattern adopted by the official apollo graphql plugin (based on `getInitialProps`). At the same time the SSR method offered by apollo client (`getDataFromTree` ) enforces the react app to render multiple times in order to collect and fetch all the relevant queries. | ||
| By declaring a top level query we can save rendering time and provide a simpler pattern which works with `getServerSideProps `. This plugin generates a typesafe version of `getServerSideProps ` for each server query, and the corresponding HOC to wrap the react component returning the cache result. The limitation/advantage of this solution is that all the queries embedded into inner react components are ignored, unless covered by the top level cache. | ||
| ## Configuration | ||
| - `excludePatterns` (default: null): regexp to exclude operation names | ||
| - `excludePatternsOptions` (default: ''): regexp flags to exclude operation names | ||
| - `reactApolloVersion` (default: 2): apollo client version | ||
| - `apolloCacheImportFrom` (default: apollo-cache-inmemory): apollo-cache-inmemory dependency | ||
| - `apolloImportFrom` (default: apollo-client v2 or @apollo/client v3): apollo client dependency | ||
| - `apolloCacheImportFrom` (default: apollo-cache-inmemory v2 or @apollo/client v3): apollo cache client dependency | ||
| - `apolloStateKey` (default: apolloState): Key used for storing Apollo state | ||
| - `withHooks` (default: false): Customized the output by enabling/disabling the generated React Hooks. | ||
| - `withHOC` (default: true): Customized the output by enabling/disabling the HOC. | ||
| - `customImports` (default: ''): full custom import declaration | ||
| - `pre` (default: ''): custom code before each function | ||
| - `post` (default: ''): custom code after each function | ||
| - `apolloClientInstanceImport`(default: ''): Add apolloClient instance imports | ||
| - `replaceQuery` (default: false): Replace "query" keyword inside the generated operations | ||
| - `replacePage` (default: false): Replace "page" keyword inside the generated operations | ||
| - `reactImport` (default: import type React from 'react';): custom react import | ||
| ## Example config | ||
| ``` | ||
| overwrite: true | ||
| schema: | ||
| - 'https://myschema/graphql' | ||
| documents: | ||
| - 'src/**/*.graphql' | ||
| generates: | ||
| src/@types/codegen/graphql.tsx: | ||
| plugins: | ||
| - 'typescript' | ||
| - 'typescript-operations' | ||
| - 'typescript-react-apollo' | ||
| src/@types/codegen/page.tsx: | ||
| config: | ||
| documentMode: external | ||
| importDocumentNodeExternallyFrom: ./graphql | ||
| preset: import-types | ||
| presetConfig: | ||
| typesPath: ./graphql | ||
| plugins: | ||
| - ./build/src/index.js | ||
| hooks: | ||
| afterAllFileWrite: | ||
| - prettier --write | ||
| ``` | ||
| # react-query gql |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-17.74%
11793
- Number of lines in readme file
- decreased by-96.36%
2
No dependency changes