https://github.com/octet-stream/apollo-link-form-data
Send your GraphQL request with apollo-link as FormData or JSON.
https://github.com/octet-stream/apollo-link-form-data
apollo-client apollo-link file-upload form-data graphql javascript-library json
Last synced: 4 months ago
JSON representation
Send your GraphQL request with apollo-link as FormData or JSON.
- Host: GitHub
- URL: https://github.com/octet-stream/apollo-link-form-data
- Owner: octet-stream
- License: mit
- Created: 2018-06-03T01:03:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T20:19:25.000Z (almost 3 years ago)
- Last Synced: 2025-05-18T22:17:39.776Z (about 1 year ago)
- Topics: apollo-client, apollo-link, file-upload, form-data, graphql, javascript-library, json
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/apollo-link-form-data
- Size: 764 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# apollo-link-form-data
Send your GraphQL request with [apollo-link](https://github.com/apollographql/apollo-link) as FormData or JSON.
[](https://travis-ci.org/octet-stream/apollo-link-form-data)
[](https://codecov.io/github/octet-stream/apollo-link-form-data?branch=master)
[](https://david-dm.org/octet-stream/apollo-link-form-data)
[](https://david-dm.org/octet-stream/apollo-link-form-data?type=dev)
## Installation
You can install this package from npm:
```
npm install apollo-link-form-data graphql
```
Or with yarn:
```sh
yarn add apollo-link-form-data graphql
```
For Node.js you also need to install following dependencies:
```sh
# 1. node-fetch ot any other fetch-compatible library instead of node-fetch
# 2. Note that you need at least 1.5.1 version of the formdata-node package
yarn add node-fetch formdata-node
```
And add this `fetch` library to options manually:
```js
import fetch from "node-fetch"
import {createFormDataLink} from "apollo-link-form-data"
const link = createFormDataLink({fetch})
```
Another thing I have to mention, is that ApolloLinkFormData uses `@octetstream/object-to-form-data` package under the hood
to convert request payload to FormData which means that your data will be sent to server in spetial format.
For more info, read the API section of then-busboy documentation: [then-busboy#bracket-notation](https://github.com/octet-stream/then-busboy#bracket-notation)
Of course, it doesn't mean that you have to use then-busboy on your server to process `multipart/form-data`
requests, but it must support mentioned format if you want to get usefull data out-of-the-box.
## Usage
Import and initialize with just two lines:
```js
import {createFormDataLink} from "apollo-link-form-data"
const link = createFormDataLink({uri: "https://api.example.com/graphql"})
```
Usage with Apollo Client:
```js
import ApolloClient from "apollo-client"
import {InMemoryCache} from "apollo-cache-in-memory"
import {createFormDataLink} from "apollo-link-form-data"
const link = createFormDataLink({
uri: "https://api.example.com/graphql"
})
const cache = new InMemoryCache()
const client = ApolloClient({link, cache})
```
## API
### `createFormDataLink(options) -> {ApolloLinkFormData}`
Creates and instance of ApolloLinkFormData with given options.
- **{object}** options.serialize – defines serialization options for @octetstream/object-to-form-data and FormData link
- **{boolean}** [options.serialize.force = false] – if `true`, request payload will be always converted to FormData.
Defaults to `false` which means that payload will be converted to FormData only when it contains at least one File.
- **{boolean}** [options.serialize.strict = false] – if `true`, all falsy booleans will be ignored. (See [#1](https://github.com/octet-stream/object-to-form-data/pull/1) PR in `@octetstream/object-to-form-data` for mode info)
**More of available options you can find in [ApolloLinkHttp documentation](https://www.apollographql.com/docs/link/links/http.html)**.
## Related links
* [then-busboy](https://github.com/octet-stream/then-busboy) is a promise-based wrapper around Busboy. Process multipart/form-data content and returns it as a single object. Will be helpful to handle your data on the server-side applications.
* [formdata-node](https://github.com/octet-stream/form-data) is an async-iterator and steam based [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) implementation for Node.js
* [@octetstream/object-to-form-data](https://github.com/octet-stream/object-to-form-data) converts JavaScript object to FormData.
* [Apollo Link](https://www.apollographql.com/docs/link/) is a standard interface for modifying control flow of GraphQL requests and fetching GraphQL results.