Attempting to create a .d.ts file for the foo-foo-mq module has presented some challenges.
Following the documentation, a 'foo-foo-mq' folder was created within the 'typings' directory at the project's root. An index.d.ts file was then added with the following content:
declare module 'foo-foo-mq' {
function configure(options: TopologyOptions): { done: (callback: () => void) => void };
export enum TopologyExchangeType { FANOUT = 'fanout', TOPIC = 'topic', DIRECT = 'direct' }
export interface TopologyExchange {
name: string;
type: TopologyExchangeType;
autoDelete?: boolean;
publishTimeout?: number;
alternate?: string;
persistent?: boolean;
}
export interface TopologyQueue {
name: string;
autoDelete: boolean;
subscribe: boolean;
queueLimit?: number;
limit?: number;
deadLetter?: string;
}
export interface TopologyBinding {
exchange: string;
target: string;
keys: Array<string>
}
export interface TopologyOptions {
connection: {
name?: string;
user?: string;
pass?: string;
host?: string | string[];
port?: number;
timeout?: number;
vhost?: string;
replyQueue?: string;
},
exchanges?: TopologyExchange[];
queues?: TopologyQueue[],
bindings?: TopologyBinding[]
}
}
The usage of the module seems to be working as expected:
import rabbit from 'foo-foo-mq'
rabbit.configure()
However, assigning the 'rabbit' variable to a private property poses a challenge in determining its type:
For example:
class SomeHiLevelClass {
constructor(private rabbit:????) {}
}
Upon examining the source code of foo-foo-mq, it was discovered that it exports an instance of the Broker class:
class Broker { ... }
module.exports = new Broker()
Is there a way to properly describe this in the .d.ts file?