jaydenseric/graphql-upload
Graphql Upload
GraphQL Upload is a utility for Node.js environments that enables GraphQL servers to process file uploads. It functions by integrating custom scalar types into the GraphQL schema and providing middleware to intercept and parse incoming multipart requests.
The library distinguishes itself by handling file data as asynchronous readable streams, which allows servers to process large files without requiring intermediate local disk storage or loading entire files into memory. It also incorporates resource protection mechanisms, including configurable limits on file sizes and the total number of files per request, to prevent memory exhaustion and maintain server stability.
Beyond its core processing capabilities, the project provides validation for multipart request structures and field types to ensure data integrity. It is designed to be installed as a dependency within existing GraphQL server architectures to facilitate standard file transmission through mutations.
Features
- GraphQL Multipart Upload Servers - Enables file transmission through GraphQL mutations by integrating multipart request support into Node.js server architectures.
- File Upload Streams - Provides file data as asynchronous readable streams to resolvers, enabling memory-efficient processing of large files without intermediate disk storage.
- GraphQL Custom Scalars - Integrates custom scalar types into GraphQL schemas to define and accept file uploads as variables.
- Upload Request Validation - Restricts the size of fields, individual files, and the total number of files per request to prevent resource exhaustion.
- Request Size Limiters - Enforces strict limits on file sizes and total request volume to prevent memory exhaustion and denial of service.
- Server-Side Upload Constraints - Implements size limits and request validation to prevent malicious file uploads from exhausting server resources.
- GraphQL Integration Middleware - Integrates file upload capabilities into Node.js GraphQL servers using custom scalar types and request middleware.
- GraphQL API Development - Facilitates GraphQL API development by enabling clients to pass file data as variables during standard operations.
- Multipart Form Parsing - Parses incoming HTTP multipart form data to extract file streams and metadata for the GraphQL execution layer.
- Request Interception Middlewares - Hooks into the server request pipeline to intercept and process multipart content types before they reach the GraphQL engine.
