graphql-upload-ts/dist/graphqlUploadKoa.d.ts

Typescript minimalistic and developer friendly middleware and an Upload scalar to add support for GraphQL multipart requests (file uploads via queries and mutations) to various Node.js GraphQL servers.

import { Context, Next } from 'koa';
type ProcessRequestOptions = {
    processRequest?: ((req: any, res: any, options: any) => Promise<any>) | (() => Promise<void>);
    maxFieldSize?: number;
    maxFileSize?: number;
    maxFiles?: number;
    [key: string]: any;
};
/**
 * Creates [Koa](https://koajs.com) middleware that processes
 * [GraphQL multipart requests](https://github.com/jaydenseric/graphql-multipart-request-spec)
 * using [`processRequest`]{@link processRequest}, ignoring non-multipart
 * requests. It sets the request body to be
 * [similar to a conventional GraphQL POST request]{@link GraphQLOperation} for
 * following GraphQL middleware to consume.
 * @example <caption>Ways to `import`.</caption>
 * ```js
 * import { graphqlUploadKoa } from 'graphql-upload-ts';
 * ```
 *
 * ```js
 * import graphqlUploadKoa from 'graphql-upload-ts/dist/graphqlUploadKoa.js';
 * ```
 * @example <caption>Ways to `require`.</caption>
 * ```js
 * const { graphqlUploadKoa } = require('graphql-upload-ts');
 * ```
 *
 * ```js
 * const graphqlUploadKoa = require('graphql-upload-ts/dist/graphqlUploadKoa');
 * ```
 * @example <caption>Basic [`graphql-api-koa`](https://npm.im/graphql-api-koa) setup.</caption>
 * ```js
 * const Koa = require('koa');
 * const bodyParser = require('koa-bodyparser');
 * const { errorHandler, execute } = require('graphql-api-koa');
 * const { graphqlUploadKoa } = require('graphql-upload-ts');
 * const schema = require('./schema');
 *
 * new Koa()
 *   .use(errorHandler())
 *   .use(bodyParser())
 *   .use(graphqlUploadKoa({ maxFileSize: 10000000, maxFiles: 10 }))
 *   .use(execute({ schema }))
 *   .listen(3000);
 * ```
 */
export declare function graphqlUploadKoa(params?: ProcessRequestOptions): (ctx: Context, next: Next) => Promise<any>;
export {};