mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
2a9265d8a2
* Added comments and updated definitions * enabled allowSyntheticDefaultImports * changed exports style and updated tests
46 lines
1.0 KiB
TypeScript
46 lines
1.0 KiB
TypeScript
// Type definitions for burns 2.0
|
|
// Project: https://github.com/shalvah/burns#readme
|
|
// Definitions by: Timothy Onyiuke <https://github.com/timolinn>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.1
|
|
|
|
declare const _Burns: Burns;
|
|
|
|
/**
|
|
* Function type for handling events
|
|
*/
|
|
type HandlerFn = (payload ?: any) => any;
|
|
|
|
/**
|
|
* This Type is an alias to the multiple
|
|
* parameter types the `registerEvent` method accepts
|
|
*/
|
|
type Handlers = string | HandlerFn | HandlerFn[];
|
|
|
|
/**
|
|
* Type Alias for event handlers
|
|
*/
|
|
type EventHandler = Handlers | Record<string, Handlers>;
|
|
|
|
/**
|
|
* Burns configuration settings
|
|
*/
|
|
interface Config {
|
|
defaultHandler?: HandlerFn;
|
|
broadcaster?: string | null;
|
|
pusher?: Record<string, any>;
|
|
}
|
|
|
|
/**
|
|
* Burns
|
|
*/
|
|
declare class Burns {
|
|
configure(config?: Config): this;
|
|
|
|
registerEvents(newEvents: Record<string, EventHandler>): this;
|
|
|
|
dispatch(eventName: string, eventData?: Record<string, any>, exclude?: { exclude?: any }): this;
|
|
}
|
|
|
|
export = _Burns;
|