Package Exports

@escape.tech/graphql-armor
@escape.tech/graphql-armor/dist/graphql-armor.cjs.js
@escape.tech/graphql-armor/dist/graphql-armor.esm.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@escape.tech/graphql-armor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

GraphQL Armor 🛡️

GraphQL Armor is a dead-simple yet highly customizable security middleware for various GraphQL server engines.

npm

Installation

# npm
npm install -S @escape.tech/graphql-armor

# yarn
yarn add @escape.tech/graphql-armor

Documentation

https://escape.tech/graphql-armor/docs/getting-started

Supported GraphQL Engines

We support the following engines :

We additionally support the following engines through the Envelop plugin system :

GraphQL-Helix
Node.js HTTP
GraphQL-Helix (with @defer and @stream)
GraphQL-WS
GraphQL-SSE
Azure Functions
Cloudflare Workers
Google Cloud Functions
Lambda AWS
type-graphql
nexus
express-graphql

See here for more information about Envelop compatibility.

Contributing

Ensure you have read the Contributing Guide before contributing.

To setup your project, make sure you run the install-dev.sh script.

git clone git@github.com:Escape-Technologies/graphql-armor.git
cd graphql-armor
bash ./install-dev.sh

We are using yarn as our package manager and the workspaces monorepo setup. Please read the associated documentation and feel free to open issues if you encounter problems when developing on our project!