70 lines
4.4 KiB
JavaScript
70 lines
4.4 KiB
JavaScript
'use strict';
|
||
|
||
exports.GraphQLUpload = require('./GraphQLUpload');
|
||
exports.processRequest = require('./processRequest');
|
||
exports.graphqlUploadKoa = require('./graphqlUploadKoa');
|
||
exports.graphqlUploadExpress = require('./graphqlUploadExpress');
|
||
exports.Upload = require('./Upload');
|
||
|
||
/**
|
||
* File upload details that are only available after the file’s field in the
|
||
* [GraphQL multipart request](https://github.com/jaydenseric/graphql-multipart-request-spec)
|
||
* has begun streaming in.
|
||
* @kind typedef
|
||
* @name FileUpload
|
||
* @type {object}
|
||
* @prop {string} filename File name.
|
||
* @prop {string} mimetype File MIME type. Provided by the client and can’t be trusted.
|
||
* @prop {string} encoding File stream transfer encoding.
|
||
* @prop {FileUploadCreateReadStream} createReadStream Creates a [Node.js readable stream](https://nodejs.org/api/stream.html#stream_readable_streams) of the file’s contents, for processing and storage.
|
||
*/
|
||
|
||
/**
|
||
* Creates a [Node.js readable stream](https://nodejs.org/api/stream.html#stream_readable_streams) of an [uploading file’s]{@link FileUpload} contents, for processing and storage. Multiple calls create independent streams. Throws if called after all resolvers have resolved, or after an error has interrupted the request.
|
||
* @kind typedef
|
||
* @name FileUploadCreateReadStream
|
||
* @type {Function}
|
||
* @param {object} [options] [`fs-capacitor`](https://npm.im/fs-capacitor) [`ReadStreamOptions`](https://github.com/mike-marcacci/fs-capacitor#readstreamoptions).
|
||
* @param {string} [options.encoding=null] Specify an encoding for the [`data`](https://nodejs.org/api/stream.html#stream_event_data) chunks to be strings (without splitting multi-byte characters across chunks) instead of Node.js [`Buffer`](https://nodejs.org/api/buffer.html#buffer_buffer) instances. Supported values depend on the [`Buffer` implementation](https://github.com/nodejs/node/blob/v13.7.0/lib/buffer.js#L587-L663) and include `utf8`, `ucs2`, `utf16le`, `latin1`, `ascii`, `base64`, or `hex`.
|
||
* @param {number} [options.highWaterMark=16384] Maximum number of bytes to store in the internal buffer before ceasing to read from the underlying resource.
|
||
* @returns {Readable} [Node.js readable stream](https://nodejs.org/api/stream.html#stream_readable_streams) of the file’s contents.
|
||
* @see [Node.js `Readable` stream constructor docs](https://nodejs.org/api/stream.html#stream_new_stream_readable_options).
|
||
* @see [Node.js stream backpressure guide](https://nodejs.org/es/docs/guides/backpressuring-in-streams).
|
||
*/
|
||
|
||
/**
|
||
* A GraphQL operation object in a shape that can be consumed and executed by
|
||
* most GraphQL servers.
|
||
* @kind typedef
|
||
* @name GraphQLOperation
|
||
* @type {object}
|
||
* @prop {string} query GraphQL document containing queries and fragments.
|
||
* @prop {string|null} [operationName] GraphQL document operation name to execute.
|
||
* @prop {object|null} [variables] GraphQL document operation variables and values map.
|
||
* @see [GraphQL over HTTP spec](https://github.com/APIs-guru/graphql-over-http#request-parameters).
|
||
* @see [Apollo Server POST requests](https://www.apollographql.com/docs/apollo-server/requests#postRequests).
|
||
*/
|
||
|
||
/**
|
||
* Processes a [GraphQL multipart request](https://github.com/jaydenseric/graphql-multipart-request-spec).
|
||
* @kind typedef
|
||
* @name ProcessRequestFunction
|
||
* @type {Function}
|
||
* @param {IncomingMessage} request [Node.js HTTP server request instance](https://nodejs.org/api/http.html#http_class_http_incomingmessage).
|
||
* @param {ServerResponse} response [Node.js HTTP server response instance](https://nodejs.org/api/http.html#http_class_http_serverresponse).
|
||
* @param {ProcessRequestOptions} [options] Options for processing the request.
|
||
* @returns {Promise<GraphQLOperation | Array<GraphQLOperation>>} GraphQL operation or batch of operations for a GraphQL server to consume (usually as the request body).
|
||
* @see [`processRequest`]{@link processRequest}.
|
||
*/
|
||
|
||
/**
|
||
* Options for processing a [GraphQL multipart request](https://github.com/jaydenseric/graphql-multipart-request-spec);
|
||
* mostly relating to security, performance and limits.
|
||
* @kind typedef
|
||
* @name ProcessRequestOptions
|
||
* @type {object}
|
||
* @prop {number} [maxFieldSize=1000000] Maximum allowed non-file multipart form field size in bytes; enough for your queries.
|
||
* @prop {number} [maxFileSize=Infinity] Maximum allowed file size in bytes.
|
||
* @prop {number} [maxFiles=Infinity] Maximum allowed number of files.
|
||
*/
|