@upstash/qstash 0.1.0 → 0.1.3

package/README.md

@@ -1,20 +1,20 @@
 # Upstash qStash SDK
 
-[![Tests](https://github.com/upstash/upstash-redis/actions/workflows/tests.yaml/badge.svg)](https://github.com/upstash/upstash-redis/actions/workflows/tests.yaml)
+[![Tests](https://github.com/upstash/sdk-qstash-ts/actions/workflows/tests.yaml/badge.svg)](https://github.com/upstash/sdk-qstash-ts/actions/workflows/tests.yaml)
 ![npm (scoped)](https://img.shields.io/npm/v/@upstash/redis)
 ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@upstash/redis)
 
-**qStash** is a serverless queueing / messaging system, designed to be used with
-serverless functions to consume from the queue.
+**qStash** is an HTTP based messaging and scheduling solution for serverless and
+edge runtimes.
 
-It is the only connectionless (HTTP based) Redis client and designed for:
+It is 100% built on stateless HTTP requests and designed for:
 
 - Serverless functions (AWS Lambda ...)
 - Cloudflare Workers (see
-  [the example](https://github.com/upstash/upstash-redis/tree/main/examples/cloudflare-workers))
-- Fastly Compute@Edge (see
-  [the example](https://github.com/upstash/upstash-redis/tree/main/examples/fastly))
-- Next.js, Jamstack ...
+  [the example](https://github.com/upstash/sdk-qstash-ts/tree/main/examples/cloudflare-workers))
+- Fastly Compute@Edge
+- Next.js, including [edge](https://nextjs.org/docs/api-reference/edge-runtime)
+- Deno
 - Client side web/mobile applications
 - WebAssembly
 - and other environments where HTTP is preferred over TCP.
@@ -51,7 +51,7 @@ npm install @upstash/qstash
 #### Deno
 
 ```ts
-import { Redis } from "https://deno.land/x/upstash_qstash/mod.ts";
+import { Client } from "https://deno.land/x/upstash_qstash/mod.ts";
 ```
 
 ### Get your authorization token
@@ -86,9 +86,8 @@ console.log(res);
 
 ### Receiving a message
 
-How to consume a message depends on your http server. QStash does not receive
-the http request directly, but should be called by you as the first step in your
-handler function.
+How to receive a message depends on your http server. The `Receiver.verify`
+method should be called by you as the first step in your handler function.
 
 ```ts
 import { Receiver } from "@upstash/qstash";
@@ -108,11 +107,6 @@ const isValid = await r.verify({
    * The raw request body.
    */
   body: "string";
-
-  /**
-   * URL of the endpoint where the request was sent to.
-   */
-  url: "string";
 })
 ```
 

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/entrypoints/nodejs.js",
   "types": "./types/entrypoints/nodejs.d.ts",
   "name": "@upstash/qstash",
-  "version": "v0.1.0",
+  "version": "v0.1.3",
   "description": "Official Deno/Typescript client for qStash",
   "repository": {
     "type": "git",

package/types/entrypoints/cloudflare.d.ts

@@ -1,5 +1,5 @@
 import * as r from "../pkg/receiver.js";
 export * from "../pkg/client/client.js";
 export declare class Receiver extends r.Receiver {
-    constructor(config: Omit<r.ReceiverConfig, "crypto">);
+    constructor(config: Omit<r.ReceiverConfig, "subtleCrypto">);
 }

package/types/entrypoints/nodejs.d.ts

@@ -1,5 +1,5 @@
 import * as r from "../pkg/receiver.js";
 export * from "../pkg/client/client.js";
 export declare class Receiver extends r.Receiver {
-    constructor(config: Omit<r.ReceiverConfig, "crypto">);
+    constructor(config: Omit<r.ReceiverConfig, "subtleCrypto">);
 }