mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-08-12 04:50:18 +00:00
Implement amqp 0.2 type definitions (#16744)
* Implement amqp 0.2 type definitions * Respond to PR feedback - Add semicoloms - Remove namespace - Change line rules
This commit is contained in:
Carl Winkler
@@ -0,0 +1,69 @@
|
||||
import * as amqp from 'amqp';
|
||||
|
||||
async function connect() {
|
||||
const promise = new Promise<amqp.AMQPClient>((resolve, reject) => {
|
||||
const client = amqp.createConnection({
|
||||
url: 'amqp://admin:password@localhost:5672'
|
||||
});
|
||||
|
||||
client.once('error', reject);
|
||||
client.once('ready', resolve);
|
||||
});
|
||||
|
||||
return promise;
|
||||
}
|
||||
|
||||
async function start() {
|
||||
try {
|
||||
const client = await connect();
|
||||
console.log('Connected');
|
||||
|
||||
const queue = client.queue('perth-now',
|
||||
{
|
||||
autoDelete: false,
|
||||
durable: true,
|
||||
}, q => {
|
||||
console.log('Queue opened');
|
||||
console.log('Name: %s Channel: %s', q.name, q.channel);
|
||||
|
||||
queue.bind('amq.fanout', '#', () => {
|
||||
queue.subscribe(
|
||||
{ ack: true },
|
||||
(msg, _, __, ack) => {
|
||||
ack.acknowledge(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
const exchange = client.exchange('amq.fanout', { confirm: true });
|
||||
|
||||
exchange.once('open', () => {
|
||||
exchange.publish(
|
||||
'content',
|
||||
{ message: new Date().toLocaleTimeString() },
|
||||
{ deliveryMode: 2 },
|
||||
(err, msg) => {
|
||||
if (!err) {
|
||||
return;
|
||||
}
|
||||
throw new Error(`Failed to publish: ${msg}`);
|
||||
}
|
||||
);
|
||||
|
||||
exchange.publish('content', { message: 'content message' }, () => {
|
||||
console.log('Published');
|
||||
});
|
||||
});
|
||||
} catch (ex) {
|
||||
console.log(ex);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
async function wait(ms: number) {
|
||||
return new Promise(resolve => {
|
||||
setTimeout(resolve, ms);
|
||||
});
|
||||
}
|
||||
|
||||
start();
|
||||
Vendored
+419
@@ -0,0 +1,419 @@
|
||||
// Type definitions for amqp 0.2
|
||||
// Project: https://github.com/postwait/node-amqp
|
||||
// Definitions by: Carl Winkler <https://github.com/seikho>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
/// <reference types="node" />
|
||||
|
||||
import * as net from 'net';
|
||||
import * as events from 'events';
|
||||
|
||||
export type Callback<T> = (value: T) => void;
|
||||
export interface AMQPClient extends net.Socket {
|
||||
publish(routingKey: string, body: any, options: {}, callback: (err?: boolean, msg?: string) => void): void;
|
||||
|
||||
disconnect(): void;
|
||||
|
||||
queue(queueName: string, callback?: Callback<QueueCallback>): AMQPQueue;
|
||||
queue(queueName: string, options: QueueOptions, callback?: Callback<QueueCallback>): AMQPQueue;
|
||||
|
||||
exchange(callback?: Callback<void>): AMQPExchange;
|
||||
exchange(exchangeName: string, callback?: Callback<void>): AMQPExchange;
|
||||
exchange(exchangeName: string, options: ExchangeOptions, callback?: Callback<void>): AMQPExchange;
|
||||
}
|
||||
|
||||
export interface AMQPQueue extends events.EventEmitter {
|
||||
subscribe(callback: SubscribeCallback): void;
|
||||
subscribe(options: SubscribeOptions, callback: SubscribeCallback): void;
|
||||
|
||||
unsubscribe(consumerTag: string): void;
|
||||
|
||||
bind(exchangeName: string, routingKey: string, callback?: Callback<AMQPQueue>): void;
|
||||
bind(routingKey: string, callback?: Callback<AMQPQueue>): void;
|
||||
|
||||
unbind(exchangeName: string, routingKey: string): void;
|
||||
unbind(routingKey: string): void;
|
||||
|
||||
bind_headers(exchangeName: string, routingKey: string): void;
|
||||
bind_headers(routingKey: string): void;
|
||||
|
||||
unbind_headers(exchangeName: string, routingKey: string): void;
|
||||
unbind_headers(routingKey: string): void;
|
||||
|
||||
shift(reject: boolean): void;
|
||||
shift(reject: boolean, requeue: boolean): void;
|
||||
|
||||
destroy(options?: DestroyOptions): void;
|
||||
}
|
||||
|
||||
export interface AMQPExchange extends events.EventEmitter {
|
||||
on(event: 'open' | 'ack' | 'error' | 'exchangeBindOk' | 'exchangeUnbindOk', callback: Callback<void>): this;
|
||||
|
||||
publish(routingKey: string, message: Buffer | {}, options: ExchangePublishOptions, callback?: (err?: boolean, msg?: string) => void): void;
|
||||
|
||||
/**
|
||||
* ifUnused default: true
|
||||
*
|
||||
* Deletes an exchange.
|
||||
*
|
||||
* If the optional boolean second argument is set, the server will only delete the exchange if it has no queue bindings.
|
||||
*
|
||||
* If the exchange has queue bindings the server does not delete it but raises a channel exception instead
|
||||
*/
|
||||
destroy(ifUnused: boolean): void;
|
||||
|
||||
bind(sourceExchange: string, routingKey: string, callback?: Callback<void>): void;
|
||||
unbind(sourceExchange: string, routingKey: string, callback?: Callback<void>): void;
|
||||
bind_headers(exchange: string, routing: string, callback?: Callback<void>): void;
|
||||
}
|
||||
|
||||
export function createConnection(options: ConnectionOptions): AMQPClient;
|
||||
|
||||
export interface DeliveryInfo {
|
||||
contentType: string;
|
||||
consumerTag: string;
|
||||
deliveryTag: Uint8Array;
|
||||
exchange: string;
|
||||
queue: string;
|
||||
redelivered: boolean;
|
||||
routingKey: string;
|
||||
}
|
||||
|
||||
export interface Ack extends DeliveryInfo {
|
||||
acknowledge(all: boolean): void;
|
||||
reject(requeue: boolean): void;
|
||||
}
|
||||
|
||||
export interface ConnectionOptions {
|
||||
host?: string;
|
||||
url?: string;
|
||||
port?: number;
|
||||
login?: string;
|
||||
passowrd?: string;
|
||||
connectionTimeout?: number;
|
||||
authMechanism?: string;
|
||||
vhost?: string;
|
||||
noDelay?: boolean;
|
||||
ssl?: {
|
||||
enabled: boolean;
|
||||
keyFile?: string;
|
||||
certFile?: string;
|
||||
caFile?: string;
|
||||
rejectUnauthorized?: boolean;
|
||||
};
|
||||
|
||||
/** Default: 'node-amqp' */
|
||||
product?: string;
|
||||
|
||||
/** Default: 'node-{NODE_VERSION}' */
|
||||
platform?: string;
|
||||
|
||||
/** Default: node-amqp/package.json version */
|
||||
version?: string;
|
||||
|
||||
defaultExchangeName?: string;
|
||||
|
||||
/** Default: true */
|
||||
reconnect?: boolean;
|
||||
|
||||
/** Default: 'linear' */
|
||||
reconnectBackoffStrategy?: string;
|
||||
|
||||
/** Default: 120000 */
|
||||
reconnectExponentialLimit?: number;
|
||||
|
||||
/** Default: 1000 */
|
||||
reconnectBackoffTime?: number;
|
||||
}
|
||||
|
||||
export interface QueueOptions {
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* If set, the server will not create the queue.
|
||||
*
|
||||
* The client can use this to check whether a queue exists without modifying the server state
|
||||
*/
|
||||
passive?: boolean;
|
||||
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* Durable queues remain active when a server restarts.
|
||||
*
|
||||
* Non-durable queues (transient queues) are purged if/when a server restarts.
|
||||
*
|
||||
* Note that durable queues do not necessarily hold persistent messages,
|
||||
* although it does not make sense to send persistent messages to a transient queue
|
||||
*/
|
||||
durable?: boolean;
|
||||
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* Exclusive queues may only be consumed from by the current connection.
|
||||
*
|
||||
* Setting the 'exclusive' flag always implies 'autoDelete'
|
||||
*/
|
||||
exclusive?: boolean;
|
||||
|
||||
/**
|
||||
* Default: true
|
||||
*
|
||||
* If set, the queue is deleted when all consumers have finished using it.
|
||||
*
|
||||
* Last consumer can be cancelled either explicitly or because its channel is closed.
|
||||
*
|
||||
* If there was no consumer ever on the queue, it won't be deleted
|
||||
*/
|
||||
autoDelete?: boolean;
|
||||
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* If set, the queue will not be declared, this will allow a queue to be deleted if you don't know its previous options
|
||||
*/
|
||||
noDeclare?: boolean;
|
||||
|
||||
/**
|
||||
* a map of additional arguments to pass in when creating a queue
|
||||
*/
|
||||
arguments?: { [arg: string]: any };
|
||||
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* when true the channel will close on unsubscribe
|
||||
*/
|
||||
closeChannelOnUnsubscribe?: boolean;
|
||||
}
|
||||
|
||||
export interface ExchangeOptions {
|
||||
/**
|
||||
* Default: 'topic'
|
||||
*/
|
||||
type?: 'direct' | 'fanout' | 'topic';
|
||||
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* f set, the server will not create the exchange. The client can use this to check whether an exchange exists without modifying the server state
|
||||
*/
|
||||
passive?: boolean;
|
||||
|
||||
/**
|
||||
* Default: true
|
||||
*
|
||||
* If set when creating a new exchange, the exchange will be marked as durable.
|
||||
*
|
||||
* Durable exchanges remain active when a server restarts.
|
||||
*
|
||||
* Non-durable exchanges (transient exchanges) are purged if/when a server restarts
|
||||
*/
|
||||
durable?: boolean;
|
||||
|
||||
/**
|
||||
* Default: true
|
||||
*
|
||||
* If set, the exchange is deleted when there are no longer queues bound to it
|
||||
*/
|
||||
autoDelete?: boolean;
|
||||
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* If set, the exchange will not be declared,
|
||||
* this will allow the exchange to be deleted if you dont know its previous options
|
||||
*/
|
||||
noDeclare?: boolean;
|
||||
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* If set, the exchange will be in confirm mode, and you will get a 'ack'|'error' event emitted on a publish,
|
||||
* or the callback on the publish will be called
|
||||
*/
|
||||
confirm?: boolean;
|
||||
|
||||
/**
|
||||
* a map of additional arguments to pass in when creating an exchange
|
||||
*/
|
||||
arguments?: { [arg: string]: any };
|
||||
}
|
||||
|
||||
export interface SubscribeOptions {
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* If set to true, only one subscriber is allowed at a time
|
||||
*/
|
||||
exclusive?: boolean;
|
||||
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* Make it so that the AMQP server only delivers single messages at a time.
|
||||
* When you want the next message, call queue.shift()
|
||||
*
|
||||
* When false, you will receive messages as fast as they are emitted
|
||||
*/
|
||||
ack?: boolean;
|
||||
|
||||
/**
|
||||
* Default: 1
|
||||
*
|
||||
* Will only send you N messages before you 'ack'.
|
||||
*
|
||||
* Setting to zero will widen that window to 'unlimited'. If this is set, queue.shift() should not be used
|
||||
*/
|
||||
prefetchCount?: number;
|
||||
|
||||
/**
|
||||
* Default: undefined
|
||||
*
|
||||
* Will inject the routingKey into the payload received
|
||||
*/
|
||||
routingKeyInPayload?: boolean;
|
||||
|
||||
/**
|
||||
* Default: undefined
|
||||
*
|
||||
* Will inject the routingKey into the payload received
|
||||
*/
|
||||
deliveryKeyInPayload?: boolean;
|
||||
}
|
||||
|
||||
export interface DestroyOptions {
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* Will only destroy the queue if it has no consumers
|
||||
*/
|
||||
ifUnused?: boolean;
|
||||
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* Will ony be deleted if the queue has no messages
|
||||
*/
|
||||
ifEmpty?: boolean;
|
||||
}
|
||||
|
||||
export type SubscribeCallback = (
|
||||
message: any,
|
||||
headers: { [key: string]: any },
|
||||
deliveryInfo: DeliveryInfo,
|
||||
ack: Ack
|
||||
) => void;
|
||||
|
||||
export interface QueueCallback {
|
||||
name: string;
|
||||
consumerTagListeners: { [tag: string]: any };
|
||||
consumerTagOptions: { [option: string]: any };
|
||||
options: QueueOptions;
|
||||
state: string;
|
||||
channel: number;
|
||||
}
|
||||
|
||||
export interface ExchangePublishOptions {
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* This flag tells the server how to react if the message cannot be routed to a queue.
|
||||
*
|
||||
* If this flag is set, the server will return an unroutable message with a Return method.
|
||||
*
|
||||
* If this flag is false, the server silently drops the message
|
||||
*/
|
||||
mandatory?: boolean;
|
||||
|
||||
/**
|
||||
* Default: false
|
||||
*
|
||||
* This flag tells the server how to react if the message cannot be routed to a queue consumer immediately.
|
||||
*
|
||||
* If this flag is set, the server will return an undeliverable message with a Return method.
|
||||
*
|
||||
* If this flag is false, the server will queue the message, but with no guarantee that it will ever be consumed
|
||||
*/
|
||||
immediate?: boolean;
|
||||
|
||||
/**
|
||||
* Default: 'application/octet-stream'
|
||||
*/
|
||||
contentType?: string;
|
||||
|
||||
/**
|
||||
* Default: null
|
||||
*/
|
||||
contentEncoding?: string;
|
||||
|
||||
/**
|
||||
* Default: {}
|
||||
*
|
||||
* Arbitrary application-specific message headers
|
||||
*/
|
||||
headers?: any;
|
||||
|
||||
/**
|
||||
* 1: Non-persistent
|
||||
* 2: Persistent
|
||||
*/
|
||||
deliveryMode?: 1 | 2;
|
||||
|
||||
priority?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
|
||||
|
||||
/**
|
||||
* Application correlation identifier
|
||||
*/
|
||||
correlationId?: string;
|
||||
|
||||
/**
|
||||
* Usually used to name a reply queue for a request message
|
||||
*/
|
||||
replyTo?: string;
|
||||
|
||||
/**
|
||||
* Default: null
|
||||
*
|
||||
* Message expiration specification -- ISO date string?
|
||||
*/
|
||||
expiration?: string;
|
||||
|
||||
/**
|
||||
* Default: null
|
||||
*
|
||||
* Application message identifier
|
||||
*/
|
||||
messageId?: string;
|
||||
|
||||
/**
|
||||
* Default: null
|
||||
*
|
||||
* Message timestamp
|
||||
*
|
||||
* ISO date string?
|
||||
*/
|
||||
timestamp?: string;
|
||||
|
||||
/**
|
||||
* Default: null
|
||||
*
|
||||
* Message type name
|
||||
*/
|
||||
type?: string;
|
||||
|
||||
/**
|
||||
* Default: null
|
||||
*
|
||||
* Creating user id
|
||||
*/
|
||||
userId?: string;
|
||||
|
||||
/**
|
||||
* Default: null
|
||||
*
|
||||
* Creating application id
|
||||
*/
|
||||
appId?: string;
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"target": "es6",
|
||||
"lib": [
|
||||
"es6"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"amqp-tests.ts"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"extends": "dtslint/dt.json",
|
||||
"rules": {
|
||||
"unified-signatures": [
|
||||
"false"
|
||||
]
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user