wassname/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/wassname/DefinitelyTyped.git synced 2026-09-09 11:13:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update Arbiter.d.ts

Browse Source
This commit is contained in:
Arash Shakery
2013-05-22 01:56:15 +04:30
parent 426740cb8d
commit 248705871f
1 changed files with 124 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Arbiter/Arbiter.d.ts
Vendored
+124 -122
View File
@@ -5,127 +5,129 @@
// May 22 2013
interface SubscribeHandler {
(data?: any, message?: string, subscriber_context?: any): void;
declare module ArbiterCore {
export interface SubscribeHandler {
(data?: any, message?: string, subscriber_context?: any): void;
}
export interface SubscribeOptions {
/**
* By default, all subscribers have a priority of 0. Higher values get higher
* priority and are executed first. Negative values are allowed.
*/
priority?: number;
/**
* A subscriber can be set to execute asynchronously, even if the message wasn't published as async.
*/
async?: bool;
/**
* If your subscriber is not interested in any past messages that may have been
* persisted, you can force them to be ignored.
*/
persist?: bool;
}
export interface PublishOptions {
/**
* By default, subscribers can return "false" to prevent subsequent subscribers from
* receiving the message. By passing cancelable:false in the options, the publisher
* can prevent canceling.
*/
cancelable?: bool;
/**
* If the publishers wants subscribers to be notified even if they subscribe later,
* setting the persist flag will do that.
*/
persist?: bool;
/**
* If you wish to notify the subscribers but return from the publish() call before
* the subscriber functions execute, use asynchronous mode
*/
async?: bool;
}
export interface ArbiterStatic {
version: string;
updated_on: string;
/**
* Creates a separate Arbiter instance.
*/
create(): ArbiterStatic;
/**
* Publishes a message to all subscribers.
* Returns: true on success, false if any subscriber has thrown a js exception.
*
* @param msg Message may be in any format, but may not contain [ ,*]. A structure like a/b/c is recommended by convention, to allow messages to be categorized.
* @param data Pass data to subscribers that contains details about the message.
*/
publish(msg: string, data?: any, options?: PublishOptions): bool;
/**
* Subscribes to messages.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*
* @param msg comma separated messages or use wildcard like a/b/*
*/
subscribe(msg: string, func: SubscribeHandler): any;
/**
* Subscribes to messages.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*
* @param msg comma separated messages or use wildcard like a/b/*
*/
subscribe(msg: string, options: SubscribeOptions, func: SubscribeHandler): any;
/**
* Subscribes to messages. Can use comma separated or wildcards in message.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*/
subscribe(msg: string, options: SubscribeOptions, context: any, func: SubscribeHandler): any;
/**
* Subscribes to messages.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*
* @param msg comma separated messages or use wildcard like a/b/*
*/
subscribe(msg: string[], func: SubscribeHandler): any;
/**
* Subscribes to messages.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*
* @param msg comma separated messages or use wildcard like a/b/*
*/
subscribe(msg: string[], options: SubscribeOptions, func: SubscribeHandler): any;
/**
* Subscribes to messages.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*
* @param msg comma separated messages or use wildcard like a/b/*
*/
subscribe(msg: string[], options: SubscribeOptions, context: any, func: SubscribeHandler): any;
/**
* Unsubscribing simply sets a flag which prevents the subscriber from executing, in case you want to re-subscribe later.
*/
unsubscribe(subscription_id: number);
/**
* After unsubscribing, you can later re-subscribe to begin receiving messages again.
*/
resubscribe(subscription_id: number);
}
}
interface SubscribeOptions {
/**
* By default, all subscribers have a priority of 0. Higher values get higher
* priority and are executed first. Negative values are allowed.
*/
priority?: number;
/**
* A subscriber can be set to execute asynchronously, even if the message wasn't published as async.
*/
async?: bool;
/**
* If your subscriber is not interested in any past messages that may have been
* persisted, you can force them to be ignored.
*/
persist?: bool;
}
interface PublishOptions {
/**
* By default, subscribers can return "false" to prevent subsequent subscribers from
* receiving the message. By passing cancelable:false in the options, the publisher
* can prevent canceling.
*/
cancelable?: bool;
/**
* If the publishers wants subscribers to be notified even if they subscribe later,
* setting the persist flag will do that.
*/
persist?: bool;
/**
* If you wish to notify the subscribers but return from the publish() call before
* the subscriber functions execute, use asynchronous mode
*/
async?: bool;
}
interface ArbiterStatic {
version: string;
updated_on: string;
/**
* Creates a separate Arbiter instance.
*/
create(): ArbiterStatic;
/**
* Publishes a message to all subscribers.
* Returns: true on success, false if any subscriber has thrown a js exception.
*
* @param msg Message may be in any format, but may not contain [ ,*]. A structure like a/b/c is recommended by convention, to allow messages to be categorized.
* @param data Pass data to subscribers that contains details about the message.
*/
publish(msg: string, data?: any, options?: PublishOptions): bool;
/**
* Subscribes to messages.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*
* @param msg comma separated messages or use wildcard like a/b/*
*/
subscribe(msg: string, func: SubscribeHandler): any;
/**
* Subscribes to messages.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*
* @param msg comma separated messages or use wildcard like a/b/*
*/
subscribe(msg: string, options: SubscribeOptions, func: SubscribeHandler): any;
/**
* Subscribes to messages. Can use comma separated or wildcards in message.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*/
subscribe(msg: string, options: SubscribeOptions, context: any, func: SubscribeHandler): any;
/**
* Subscribes to messages.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*
* @param msg comma separated messages or use wildcard like a/b/*
*/
subscribe(msg: string[], func: SubscribeHandler): any;
/**
* Subscribes to messages.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*
* @param msg comma separated messages or use wildcard like a/b/*
*/
subscribe(msg: string[], options: SubscribeOptions, func: SubscribeHandler): any;
/**
* Subscribes to messages.
* Returns: subscription id or [id1,id2] if subscribing to multiple messages
*
* @param msg comma separated messages or use wildcard like a/b/*
*/
subscribe(msg: string[], options: SubscribeOptions, context: any, func: SubscribeHandler): any;
/**
* Unsubscribing simply sets a flag which prevents the subscriber from executing, in case you want to re-subscribe later.
*/
unsubscribe(subscription_id: number);
/**
* After unsubscribing, you can later re-subscribe to begin receiving messages again.
*/
resubscribe(subscription_id: number);
}
declare var Arbiter: ArbiterStatic;
declare var Arbiter: ArbiterCore.ArbiterStatic;