kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-05-16 19:09:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #24199 from kevynb/master

Browse Source 
[seneca] Add generic types to `add` and `act` methods
This commit is contained in:
Arthur Ozga
2018-03-15 12:39:48 -07:00
committed by GitHub
parent 324abe5a00 93d6856546
commit c7451cfa63
2 changed files with 75 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
types/seneca/index.d.ts vendored
View File

@@ -1,7 +1,9 @@
// Type definitions for seneca v2.1.0
// Project: https://www.npmjs.com/package/seneca
// Definitions by: Peter Snider <https://github.com/psnider>
// Kevyn Bruyere <https://github.com/kevynb>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped/seneca
// TypeScript Version: 2.3
declare module "seneca" {
@@ -168,11 +170,21 @@ declare module "seneca" {
sort$?: any;
}
interface PartialMessagePayload {
transport$: object | {};
plugin$: any;
fatal$: boolean;
tx$: string;
}
type MessagePayload<T> = PartialMessagePayload & T;
type Pattern = string | MinimalPattern;
type GlobalErrorHandler = (error: Error) => void;
type AddCallback = (msg: any, respond: (error: Error | null, msg?: any) => void) => void;
type AddCallback<T = any> = (
msg: MessagePayload<T>,
respond: (error: Error | null, msg?: any) => void,
) => void;
type ActCallback = (error: Error | null, result?: any) => void;
type CloseCallback = (optional: any, done: (error: Error) => void) => void;
type DatabaseID = string;
@@ -199,10 +211,18 @@ declare module "seneca" {
ready(callback: (error: Error) => void): void;
add(pattern: Pattern, action: AddCallback): this;
add(pattern: Pattern, paramspec: any, action: AddCallback): this;
act(pattern: Pattern, respond: ActCallback): void;
act(pattern: Pattern, msg: any, respond: ActCallback): void;
add<PatternType = any, CallBackParams = any>(
pattern: PatternType,
action: AddCallback<PatternType & CallBackParams>,
): this;
add<PatternType = any, CallbackParams = any>(
pattern: PatternType,
paramspec: any,
action: AddCallback<PatternType & CallbackParams>,
): this;
act<PatternWithArgs = Pattern>(pattern: PatternWithArgs, respond: ActCallback): void;
act<PatternWithArgs = Pattern>(pattern: PatternWithArgs, msg: any, respond: ActCallback): void;
make(entity_canon: string, properties?: any): Entity;
make(base: string, entity_canon: string, properties?: any): Entity;
make(zone: string, base: string, entity_canon: string, properties?: any): Entity;

50
types/seneca/seneca-tests.ts
View File

@@ -126,3 +126,53 @@ seneca.act('cmd:salestax,net:100,country:US,state:NY', function (err, result) {
seneca.act('cmd:salestax,net:100,country:IE,category:reduced', function (err, result) {
console.log('IE: ' + result.total)
})
/** With Generic Type usage **/
seneca.add<SalestaxPattern, SalestaxParams>({cmd: 'salestax'}, function(args, callback) {
var rate = 0.23;
var total = args.net * (1 + rate);
callback(null, {total: total});
});
seneca.act<SalesTaxRequest>({cmd: 'salestax', net: 100}, function(err, result) {
console.log(result.total);
});
seneca.add<ConfigPattern, ConfigParams>({cmd: 'config'}, function(args, callback) {
var config: any = {
// any added here due to following config[] access
rate: 0.23,
};
var value = config[args.prop];
callback(null, {value: value});
});
seneca.add<SalestaxPattern, SalestaxParams>({cmd: 'salestax'}, function(args, callback) {
seneca.act<ConfigRequest>({cmd: 'config', prop: 'rate'}, function(err, result) {
var rate = parseFloat(result.value);
var total = args.net * (1 + rate);
callback(null, {total: total});
});
});
interface SalestaxPattern {
cmd: 'salestax';
}
interface SalestaxParams {
net: number;
}
export interface SalesTaxRequest extends SalestaxPattern, SalestaxParams {}
interface ConfigPattern {
cmd: 'config';
}
interface ConfigParams {
prop: string;
}
export interface ConfigRequest extends ConfigPattern, ConfigParams {}