@upstash/qstash 2.5.2 → 2.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.mts +19 -5
- package/index.d.ts +19 -5
- package/index.js +2 -1
- package/index.mjs +2 -1
- package/package.json +1 -1
package/index.d.mts
CHANGED
|
@@ -175,6 +175,10 @@ type Message = {
|
|
|
175
175
|
* The failure callback url if configured.
|
|
176
176
|
*/
|
|
177
177
|
failureCallback?: string;
|
|
178
|
+
/**
|
|
179
|
+
* The queue name if this message was sent to a queue.
|
|
180
|
+
*/
|
|
181
|
+
queueName?: string;
|
|
178
182
|
};
|
|
179
183
|
declare class Messages {
|
|
180
184
|
private readonly http;
|
|
@@ -228,7 +232,6 @@ type QueueResponse = {
|
|
|
228
232
|
type UpsertQueueRequest = {
|
|
229
233
|
parallelism: number;
|
|
230
234
|
};
|
|
231
|
-
type EnqueueRequest = PublishRequest;
|
|
232
235
|
declare class Queue {
|
|
233
236
|
private readonly http;
|
|
234
237
|
private readonly queueName;
|
|
@@ -252,7 +255,7 @@ declare class Queue {
|
|
|
252
255
|
/**
|
|
253
256
|
* Enqueue a message to a queue.
|
|
254
257
|
*/
|
|
255
|
-
enqueue(request:
|
|
258
|
+
enqueue<TRequest extends PublishRequest>(request: TRequest): Promise<PublishResponse<TRequest>>;
|
|
256
259
|
/**
|
|
257
260
|
* Enqueue a message to a queue, serializing the body to JSON.
|
|
258
261
|
*/
|
|
@@ -393,6 +396,14 @@ type RemoveEndpointsRequest = {
|
|
|
393
396
|
})[];
|
|
394
397
|
};
|
|
395
398
|
type Topic = {
|
|
399
|
+
/**
|
|
400
|
+
* A unix timestamp (milliseconds)
|
|
401
|
+
*/
|
|
402
|
+
createdAt: number;
|
|
403
|
+
/**
|
|
404
|
+
* A unix timestamp (milliseconds)
|
|
405
|
+
*/
|
|
406
|
+
updatedAt: number;
|
|
396
407
|
/**
|
|
397
408
|
* The name of this topic.
|
|
398
409
|
*/
|
|
@@ -445,6 +456,9 @@ type ClientConfig = {
|
|
|
445
456
|
*/
|
|
446
457
|
retry?: RetryConfig;
|
|
447
458
|
};
|
|
459
|
+
type PublishBatchRequest<TBody = BodyInit> = PublishRequest<TBody> & {
|
|
460
|
+
queueName?: string;
|
|
461
|
+
};
|
|
448
462
|
type PublishRequest<TBody = BodyInit> = {
|
|
449
463
|
/**
|
|
450
464
|
* The message to send.
|
|
@@ -624,11 +638,11 @@ declare class Client {
|
|
|
624
638
|
/**
|
|
625
639
|
* Batch publish messages to QStash.
|
|
626
640
|
*/
|
|
627
|
-
batch(request:
|
|
641
|
+
batch(request: PublishBatchRequest[]): Promise<PublishResponse<PublishRequest>[]>;
|
|
628
642
|
/**
|
|
629
643
|
* Batch publish messages to QStash, serializing each body to JSON.
|
|
630
644
|
*/
|
|
631
|
-
batchJSON<TBody = unknown, TRequest extends
|
|
645
|
+
batchJSON<TBody = unknown, TRequest extends PublishBatchRequest<TBody> = PublishBatchRequest<TBody>>(request: TRequest[]): Promise<PublishResponse<TRequest>[]>;
|
|
632
646
|
/**
|
|
633
647
|
* Retrieve your logs.
|
|
634
648
|
*
|
|
@@ -670,4 +684,4 @@ declare class QstashRatelimitError extends QstashError {
|
|
|
670
684
|
constructor(args: unknown);
|
|
671
685
|
}
|
|
672
686
|
|
|
673
|
-
export { type AddEndpointsRequest, type BodyInit, Client, type CreateScheduleRequest, type Endpoint, type Event, type EventsRequest, type GetEventsResponse, type HeadersInit, type Message, Messages, type PublishJsonRequest, type PublishRequest, type PublishResponse, type PublishToTopicResponse, type PublishToUrlResponse, QstashError, QstashRatelimitError, type QueueRequest, Receiver, type ReceiverConfig, type RemoveEndpointsRequest, type Schedule, Schedules, SignatureError, type State, type Topic, Topics, type VerifyRequest, type WithCursor };
|
|
687
|
+
export { type AddEndpointsRequest, type BodyInit, Client, type CreateScheduleRequest, type Endpoint, type Event, type EventsRequest, type GetEventsResponse, type HeadersInit, type Message, Messages, type PublishBatchRequest, type PublishJsonRequest, type PublishRequest, type PublishResponse, type PublishToTopicResponse, type PublishToUrlResponse, QstashError, QstashRatelimitError, type QueueRequest, Receiver, type ReceiverConfig, type RemoveEndpointsRequest, type Schedule, Schedules, SignatureError, type State, type Topic, Topics, type VerifyRequest, type WithCursor };
|
package/index.d.ts
CHANGED
|
@@ -175,6 +175,10 @@ type Message = {
|
|
|
175
175
|
* The failure callback url if configured.
|
|
176
176
|
*/
|
|
177
177
|
failureCallback?: string;
|
|
178
|
+
/**
|
|
179
|
+
* The queue name if this message was sent to a queue.
|
|
180
|
+
*/
|
|
181
|
+
queueName?: string;
|
|
178
182
|
};
|
|
179
183
|
declare class Messages {
|
|
180
184
|
private readonly http;
|
|
@@ -228,7 +232,6 @@ type QueueResponse = {
|
|
|
228
232
|
type UpsertQueueRequest = {
|
|
229
233
|
parallelism: number;
|
|
230
234
|
};
|
|
231
|
-
type EnqueueRequest = PublishRequest;
|
|
232
235
|
declare class Queue {
|
|
233
236
|
private readonly http;
|
|
234
237
|
private readonly queueName;
|
|
@@ -252,7 +255,7 @@ declare class Queue {
|
|
|
252
255
|
/**
|
|
253
256
|
* Enqueue a message to a queue.
|
|
254
257
|
*/
|
|
255
|
-
enqueue(request:
|
|
258
|
+
enqueue<TRequest extends PublishRequest>(request: TRequest): Promise<PublishResponse<TRequest>>;
|
|
256
259
|
/**
|
|
257
260
|
* Enqueue a message to a queue, serializing the body to JSON.
|
|
258
261
|
*/
|
|
@@ -393,6 +396,14 @@ type RemoveEndpointsRequest = {
|
|
|
393
396
|
})[];
|
|
394
397
|
};
|
|
395
398
|
type Topic = {
|
|
399
|
+
/**
|
|
400
|
+
* A unix timestamp (milliseconds)
|
|
401
|
+
*/
|
|
402
|
+
createdAt: number;
|
|
403
|
+
/**
|
|
404
|
+
* A unix timestamp (milliseconds)
|
|
405
|
+
*/
|
|
406
|
+
updatedAt: number;
|
|
396
407
|
/**
|
|
397
408
|
* The name of this topic.
|
|
398
409
|
*/
|
|
@@ -445,6 +456,9 @@ type ClientConfig = {
|
|
|
445
456
|
*/
|
|
446
457
|
retry?: RetryConfig;
|
|
447
458
|
};
|
|
459
|
+
type PublishBatchRequest<TBody = BodyInit> = PublishRequest<TBody> & {
|
|
460
|
+
queueName?: string;
|
|
461
|
+
};
|
|
448
462
|
type PublishRequest<TBody = BodyInit> = {
|
|
449
463
|
/**
|
|
450
464
|
* The message to send.
|
|
@@ -624,11 +638,11 @@ declare class Client {
|
|
|
624
638
|
/**
|
|
625
639
|
* Batch publish messages to QStash.
|
|
626
640
|
*/
|
|
627
|
-
batch(request:
|
|
641
|
+
batch(request: PublishBatchRequest[]): Promise<PublishResponse<PublishRequest>[]>;
|
|
628
642
|
/**
|
|
629
643
|
* Batch publish messages to QStash, serializing each body to JSON.
|
|
630
644
|
*/
|
|
631
|
-
batchJSON<TBody = unknown, TRequest extends
|
|
645
|
+
batchJSON<TBody = unknown, TRequest extends PublishBatchRequest<TBody> = PublishBatchRequest<TBody>>(request: TRequest[]): Promise<PublishResponse<TRequest>[]>;
|
|
632
646
|
/**
|
|
633
647
|
* Retrieve your logs.
|
|
634
648
|
*
|
|
@@ -670,4 +684,4 @@ declare class QstashRatelimitError extends QstashError {
|
|
|
670
684
|
constructor(args: unknown);
|
|
671
685
|
}
|
|
672
686
|
|
|
673
|
-
export { type AddEndpointsRequest, type BodyInit, Client, type CreateScheduleRequest, type Endpoint, type Event, type EventsRequest, type GetEventsResponse, type HeadersInit, type Message, Messages, type PublishJsonRequest, type PublishRequest, type PublishResponse, type PublishToTopicResponse, type PublishToUrlResponse, QstashError, QstashRatelimitError, type QueueRequest, Receiver, type ReceiverConfig, type RemoveEndpointsRequest, type Schedule, Schedules, SignatureError, type State, type Topic, Topics, type VerifyRequest, type WithCursor };
|
|
687
|
+
export { type AddEndpointsRequest, type BodyInit, Client, type CreateScheduleRequest, type Endpoint, type Event, type EventsRequest, type GetEventsResponse, type HeadersInit, type Message, Messages, type PublishBatchRequest, type PublishJsonRequest, type PublishRequest, type PublishResponse, type PublishToTopicResponse, type PublishToUrlResponse, QstashError, QstashRatelimitError, type QueueRequest, Receiver, type ReceiverConfig, type RemoveEndpointsRequest, type Schedule, Schedules, SignatureError, type State, type Topic, Topics, type VerifyRequest, type WithCursor };
|
package/index.js
CHANGED
|
@@ -500,7 +500,8 @@ var Client = class {
|
|
|
500
500
|
messages.push({
|
|
501
501
|
destination: _nullishCoalesce(message.url, () => ( message.topic)),
|
|
502
502
|
headers: headerEntries,
|
|
503
|
-
body: message.body
|
|
503
|
+
body: message.body,
|
|
504
|
+
...message.queueName && { queue: message.queueName }
|
|
504
505
|
});
|
|
505
506
|
}
|
|
506
507
|
const response = await this.http.request({
|
package/index.mjs
CHANGED
|
@@ -500,7 +500,8 @@ var Client = class {
|
|
|
500
500
|
messages.push({
|
|
501
501
|
destination: message.url ?? message.topic,
|
|
502
502
|
headers: headerEntries,
|
|
503
|
-
body: message.body
|
|
503
|
+
body: message.body,
|
|
504
|
+
...message.queueName && { queue: message.queueName }
|
|
504
505
|
});
|
|
505
506
|
}
|
|
506
507
|
const response = await this.http.request({
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"v2.5.
|
|
1
|
+
{"version":"v2.5.3","name":"@upstash/qstash","description":"Official Typescript client for QStash","author":"Andreas Thomas <dev@chronark.com>","license":"MIT","homepage":"https://github.com/upstash/sdk-qstash-ts#readme","repository":{"type":"git","url":"git+https://github.com/upstash/sdk-qstash-ts.git"},"bugs":{"url":"https://github.com/upstash/sdk-qstash-ts/issues"},"main":"./index.js","module":"./index.mjs","types":"./index.d.ts","files":["./**"],"exports":{".":{"import":"./index.mjs","require":"./index.js"},"./nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./dist/nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"}},"typesVersions":{"*":{"nextjs":["./nextjs.d.ts"]}},"keywords":["qstash","queue","events","serverless","upstash"],"scripts":{"build":"tsup && cp README.md ./dist/ && cp package.json ./dist/ && cp LICENSE ./dist/","test":"bun test","fmt":"prettier --write .","lint":"tsc && eslint \"src/**/*.{js,ts,tsx}\" --quiet --fix"},"devDependencies":{"@commitlint/cli":"^19.2.2","@commitlint/config-conventional":"^19.2.2","@types/bun":"^1.1.1","@types/crypto-js":"^4.2.0","@typescript-eslint/eslint-plugin":"^7.0.1","@typescript-eslint/parser":"^7.0.1","bun-types":"^1.1.7","eslint":"^8","eslint-plugin-unicorn":"^51.0.1","husky":"^9.0.10","next":"^14.0.2","prettier":"^3.2.5","tsup":"latest","typescript":"^5.4.5","undici-types":"^6.16.0","vitest":"latest"},"dependencies":{"crypto-js":">=4.2.0","jose":"^ 5.2.3"}}
|