![\"Afosto\"](\"https://content.afosto.io/5719193282412544/brand/AFO-Logo-compleet-kleur-RGBat4x.png?w=268\"){kind=logo}
\n\n \n
\n ![\"npm](\"https://img.shields.io/npm/v/@afosto/graphql-client.svg\")
\n ![\"License\"](\"https://img.shields.io/badge/license-MIT-informational\"){kind=icon}
This library provides a GraphQL client which by default communicates with the Afosto GraphQL endpoint.\n\n## Installation\n\n```sh\n# Install with Yarn\nyarn add @afosto/graphql-client graphql\n\n# Install with NPM\nnpm install @afosto/graphql-client graphql\n```\n\n## Basic usage\n\n```js\nimport { graphQLClient, gql } from '@afosto/graphql-client';\n\n// For authentication\ngraphQLClient.setAuthorizationHeader('AUTH_TOKEN');\n\n// Your graphQL query and variables.\nconst query = gql``; \nconst variables = {};\n\n// Request\nawait graphQLClient.request(query, variables);\n```\n\n## Custom configuration\n\nIf you would like to use the GraphQLClient with other configuration than the default configuration.\n\n| Option | Description | Default |\n|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|\n| url | The base url for the client. | https://afosto.app/graphql |\n| convertResponseToCamelCase | Whether to convert the response data to camel case. | true | \n| convertVariablesToSnakeCase | Whether to convert the variables to snake case. | true | | \n| excludeConversionKeys | Set the keys that should be excluded from being converted to camel case and snake case. | [] | | \n| stopPaths | Exclude children at the given object paths in dot-notation from being converted to camel case.
Note: Is not yet implemented for snake case conversion | [] | | \n\n
\nThe other configuration options are the options that are available on the graphql-request GraphQLClient.\n
\n\n```js\nimport { createGraphQLClient } from '@afosto/graphql-client';\n\nconst client = createGraphQLClient({\n // Your configuration.\n});\n\n// For authentication\nclient.setAuthorizationHeader('AUTH_TOKEN');\n\n// Your graphQL query and variables.\nconst query = gql``;\nconst variables = {};\n\n// Request\nawait client.request(query, variables);\n```\n\n## Default response transformation\n\nBy default the Afosto GraphQLClient will transform the response keys to camel case and the variable keys to snake case. If you would like to change these settings, you can do the following:\n\n### Default client\n\n```js\ngraphQLClient.setConvertResponseToCamelCase(false);\ngraphQLClient.setConvertVariablesToSnakeCase(false);\n```\n\n### Custom client\n\n```js\nimport { createGraphQLClient } from '@afosto/graphql-client';\n\nconst client = createGraphQLClient({\n // Your configuration.\n convertResponseToCamelCase: false,\n convertVariablesToSnakeCase: false,\n});\n\n// Or after client initialization\nclient.setConvertResponseToCamelCase(false);\nclient.setConvertVariablesToSnakeCase(false);\n```\n\n## Custom response transformation\n\nIf you would like to alter the response data yourself, you can use the following:\n\n```js\nawait graphQLClient.request(query, variables, {\n transformResponse: [\n response => {\n // Alter and return your new response data.\n return response;\n },\n ],\n});\n```\n\n## Compatibility\n\n- Node >= 18\n","readmeFilename":"README.MD"}