inngest - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

components/InngestFunction.js

@@ -78,3 +78,3 @@ "use strict";
                 const url = new URL(baseUrl.href);
-                url.searchParams.set(consts_1.fnIdParam, __classPrivateFieldGet(this, _InngestFunction_opts, "f").name);
+                url.searchParams.set(consts_1.fnIdParam, this.id);
                 url.searchParams.set(consts_1.stepIdParam, stepId);
@@ -81,0 +81,0 @@ return Object.assign(Object.assign({}, acc), { [stepId]: {

package.json

 {
   "name": "inngest",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Official SDK for Inngest.com",
@@ -5,0 +5,0 @@ "main": "./index.js",

README.md

@@ -1,26 +0,54 @@
-# inngest
+<div align="center">
+  <br/>
+    <img src="https://user-images.githubusercontent.com/306177/191580717-1f563f4c-31e3-4aa0-848c-5ddc97808a9a.png" width="250" />
+  <br/>
+  <br/>
+  <p>
+    Serverless event-driven queues, background jobs, and scheduled jobs for Typescript.<br />
+    Works with any framework and platform.
+  </p>
+  Read the <a href="https://https://www.inngest.com/docs">documentation</a> and get started in minutes.
+  <br/>
+  <p>
 
-[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
-[![npm version](https://img.shields.io/npm/v/inngest)](https://www.npmjs.com/package/inngest)
-[![Discord](https://img.shields.io/discord/842170679536517141?label=discord)](https://discord.gg/EuesV2ZSnX)
-[![Twitter Follow](https://img.shields.io/twitter/follow/inngest?style=social)](https://twitter.com/inngest)
+<a href="http://www.typescriptlang.org/"><img src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg" /></a>
+<a href="https://www.npmjs.com/package/inngest"><img src="https://img.shields.io/npm/v/inngest" /></a>
+<a href="https://discord.gg/EuesV2ZSnX"><img src="https://img.shields.io/discord/842170679536517141?label=discord" /></a>
+<a href="https://twitter.com/inngest"><img src="https://img.shields.io/twitter/follow/inngest?style=social" /></a>
 
-Build, test, and deploy code that runs in response to events or on a schedule right in your own codebase.
+  </p>
+</div>
 
-👋 _**Have a question or feature request? [Join our Discord](https://www.inngest.com/discord)!**_
+<hr />
 
-```
-npm install inngest
-```
+Build, test, and deploy code that runs in response to events or on a schedule right in your own codebase.<br />
+👋 _Have a question or feature request? [Join our Discord](https://www.inngest.com/discord)!_
 
-```ts
-// Send events
-import { Inngest } from "inngest";
-const inngest = new Inngest({ name: "My App" });
+<br />
 
-inngest.send("app/user.created", { data: { id: 123 } });
+<p align="center">
+<a href="#getting-started">Getting started</a> · 
+<a href="#features">Features</a> · 
+<a href="#contributing">Contributing</a> · 
+<a href="https://www.inngest.com/docs">Documentation</a>
+</p>
+
+<br />
+
+## Getting started
+
+<br />
+
+Install Inngest:
+
+```bash
+npm install inngest  # or yarn install inngest
 ```
 
+<br />
+
+**Writing functions**: Write serverless functions and background jobs right in your own code:
+
 ```ts
-// Listen to events
+
 import { createFunction } from "inngest";
@@ -30,3 +58,3 @@
   "Send welcome email",
-  "app/user.created",
+  "app/user.created", // Subscribe to the `app/user.created` event.
   ({ event }) => {
@@ -38,2 +66,35 @@ sendEmailTo(event.data.id, "Welcome!");
 
+Functions listen to events which can be triggered by API calls, webhooks, integrations, or external services.  When a matching event is received, the serverless function runs automatically, with built in retries.
+
+<br />
+
+**Triggering functions by events:**  Send events to trigger functions automatically.
+
+
+```ts
+// Send events
+import { Inngest } from "inngest";
+const inngest = new Inngest({ name: "My App" });
+
+// This will run the function above automatically, in the background
+inngest.send("app/user.created", { data: { id: 123 } });
+```
+
+Events trigger any number of functions automatically, in parallel, in the background.
+
+
+<br />
+
+## Features
+
+- **Fully serverless:**  Run background jobs, scheduled functions, and build event-driven systems without any servers, state, or setup
+- **Deploy anywhere**:  works with NextJS, Netlify, Vercel, Redwood, Express, Cloudflare, and Lambda
+- **Use your existing code:**  write functions within your current project, zero learning required
+- **A complete platform**:  complex functionality built in, such as **event replay**, **canary deploys**, **version management** and **git integration**
+- **Fully typed**:  Event schemas, versioning, and governance out of the box
+- **Observable**:  A full UI for managing and inspecting your functions
+- **Any language:**  Use our CLI to write functions using any language
+
+<br />
+
 ## Contributing
@@ -40,0 +101,0 @@

src/version.ts

 // Generated by genversion.
-export const version = "0.4.0";
+export const version = "0.4.1";

version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "0.4.0-beta.10";
+export declare const version = "0.4.0";
 //# sourceMappingURL=version.d.ts.map

version.js

@@ -5,3 +5,3 @@ "use strict";
 // Generated by genversion.
-exports.version = "0.4.0-beta.10";
+exports.version = "0.4.0";
 //# sourceMappingURL=version.js.map

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

119249

increased by1.75%

Number of lines in readme file

110

increased by124.49%

No dependency changes