@envelop/graphql-jit 4.3.0-alpha-26c4ae2.0 → 4.3.0

package/README.md

@@ -0,0 +1,80 @@
+## `@envelop/graphql-jit`
+
+This plugins replaces the original `execute` of GraphQL with [`graphql-jit`](https://github.com/zalando-incubator/graphql-jit).
+
+## Getting Started
+
+```
+yarn add @envelop/graphql-jit
+```
+
+## Usage Example
+
+```ts
+import { envelop } from '@envelop/core';
+import { useGraphQlJit } from '@envelop/graphql-jit';
+
+const getEnveloped = envelop({
+  plugins: [
+    // ... other plugins ...
+    useGraphQlJit(
+      {
+        // your compiler options here. See https://github.com/zalando-incubator/graphql-jit#compiledquery--compilequeryschema-document-operationname-compileroptions
+      },
+      {
+        onError: (e: Error) => { ... } // custom error handler
+      }
+    ),
+  ],
+});
+```
+
+## Conditional Execution
+
+If you wish to conditionally use the JIT executor based on the incoming request, you can use `enableIf` config flag and return a `boolean` based on the `ExecutionArgs`:
+
+```ts
+import { envelop } from '@envelop/core';
+import { useGraphQlJit } from '@envelop/graphql-jit';
+
+const getEnveloped = envelop({
+  plugins: [
+    // ... other plugins ...
+    useGraphQlJit(
+      {
+        // your compiler options here. See https://github.com/zalando-incubator/graphql-jit#compiledquery--compilequeryschema-document-operationname-compileroptions
+      },
+      {
+        enableIf: executionArgs => executionArgs.contextValue.shouldUseJit,
+      }
+    ),
+  ],
+});
+```
+
+## Configuring JIT cache
+
+You can configure the JIT cache with the following options:
+
+```ts
+import { envelop } from '@envelop/core';
+import { useGraphQlJit } from '@envelop/graphql-jit';
+
+const getEnveloped = envelop({
+  plugins: [
+    // ... other plugins ...
+    useGraphQlJit(
+      {
+        // your compiler options here
+      },
+      {
+        cache: lru(), // Pass in a custom cache instance, by default a new LRU cache is created which uses the default `max` and `ttl` settings
+      }
+    ),
+  ],
+});
+```
+
+## Notes
+
+You can find more details here: https://github.com/zalando-incubator/graphql-jit

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/graphql-jit",
-  "version": "4.3.0-alpha-26c4ae2.0",
+  "version": "4.3.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.4.0-alpha-26c4ae2.0",
+    "@envelop/core": "^2.4.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {