735

在 TypeScript 中,我可以将函数的参数声明为函数类型。有没有我想念的“类型安全”的方式来做到这一点?例如,考虑一下:

class Foo {
    save(callback: Function) : void {
        //Do the save
        var result : number = 42; //We get a number from the save operation
        //Can I at compile-time ensure the callback accepts a single parameter of type number somehow?
        callback(result);
    }
}

var foo = new Foo();
var callback = (result: string) : void => {
    alert(result);
}
foo.save(callback);

保存回调不是类型安全的,我给它一个回调函数,其中函数的参数是一个字符串,但我传递给它一个数字,并且编译没有错误。我可以在保存类型安全函数中设置结果参数吗?

TL;DR 版本:TypeScript 中是否有一个等效的 .NET 委托?

4

9 回答 9

1008

当然。函数的类型由其参数的类型和返回类型组成。这里我们指定callback参数的类型必须是“接受数字并返回类型的函数any”:

class Foo {
    save(callback: (n: number) => any) : void {
        callback(42);
    }
}
var foo = new Foo();

var strCallback = (result: string) : void => {
    alert(result);
}
var numCallback = (result: number) : void => {
    alert(result.toString());
}

foo.save(strCallback); // not OK
foo.save(numCallback); // OK

如果你愿意,你可以定义一个类型别名来封装它:

type NumberCallback = (n: number) => any;

class Foo {
    // Equivalent
    save(callback: NumberCallback) : void {
        callback(42);
    }
}
于 2013-02-01T03:25:19.147 回答
105

以下是一些常见的 .NET 委托的 TypeScript 等价物:

interface Action<T>
{
    (item: T): void;
}

interface Func<T,TResult>
{
    (item: T): TResult;
}
于 2014-06-04T09:59:52.393 回答
23
type FunctionName = (n: inputType) => any;

class ClassName {
    save(callback: FunctionName) : void {
        callback(data);
    }
}

这肯定符合函数式编程范式。

于 2017-08-18T04:29:39.640 回答
19

我意识到这篇文章很旧,但是有一种更紧凑的方法,与所要求的略有不同,但可能是一个非常有用的选择。您可以在调用方法时(在这种情况下为Foo's )内联声明函数。save()它看起来像这样:

class Foo {
    save(callback: (n: number) => any) : void {
        callback(42)
    }

    multipleCallbacks(firstCallback: (s: string) => void, secondCallback: (b: boolean) => boolean): void {
        firstCallback("hello world")

        let result: boolean = secondCallback(true)
        console.log("Resulting boolean: " + result)
    }
}

var foo = new Foo()

// Single callback example.
// Just like with @RyanCavanaugh's approach, ensure the parameter(s) and return
// types match the declared types above in the `save()` method definition.
foo.save((newNumber: number) => {
    console.log("Some number: " + newNumber)

    // This is optional, since "any" is the declared return type.
    return newNumber
})

// Multiple callbacks example.
// Each call is on a separate line for clarity.
// Note that `firstCallback()` has a void return type, while the second is boolean.
foo.multipleCallbacks(
    (s: string) => {
         console.log("Some string: " + s)
    },
    (b: boolean) => {
        console.log("Some boolean: " + b)
        let result = b && false

        return result
    }
)

multipleCallback()方法对于诸如可能成功或失败的网络调用之类的事情非常有用。再次假设一个网络调用示例,当multipleCallbacks()被调用时,成功和失败的行为都可以在一个地方定义,这有助于未来的代码阅读器更加清晰。

一般来说,根据我的经验,这种方法更简洁,更简洁,整体上更清晰。

祝大家好运!

于 2017-01-25T19:00:15.467 回答
7

在 TS 中,我们可以通过以下方式键入函数:

函数类型/签名

这用于函数/方法的实际实现,它具有以下语法:

(arg1: Arg1type, arg2: Arg2type) : ReturnType

例子:

function add(x: number, y: number): number {
    return x + y;
}

class Date {
  setTime(time: number): number {
   // ...
  }

}

函数类型文字

函数类型文字是另一种声明函数类型的方法。它们通常应用于高阶函数的函数签名中。高阶函数是接受函数作为参数或返回函数的函数。它具有以下语法:

(arg1: Arg1type, arg2: Arg2type) => ReturnType

例子:

type FunctionType1 = (x: string, y: number) => number;

class Foo {
    save(callback: (str: string) => void) {
       // ...
    }

    doStuff(callback: FunctionType1) {
       // ...
    }

}
于 2019-07-04T11:46:23.350 回答
4

因为你不能轻易地将函数定义和另一种数据类型结合起来,所以我发现这些类型对强类型很有用。根据德鲁的回答。

type Func<TArgs extends any[], TResult> = (...args: TArgs) => TResult; 
//Syntax sugar
type Action<TArgs extends any[]> = Func<TArgs, undefined>; 

现在您可以强输入每个参数和返回类型!这是一个比上面更多参数的示例。

save(callback: Func<[string, Object, boolean], number>): number
{
    let str = "";
    let obj = {};
    let bool = true;
    let result: number = callback(str, obj, bool);
    return result;
}

现在您可以编写联合类型,如对象或返回对象的函数,而无需创建可能需要导出或使用的全新类型。

//THIS DOESN'T WORK
let myVar1: boolean | (parameters: object) => boolean;

//This works, but requires a type be defined each time
type myBoolFunc = (parameters: object) => boolean;
let myVar1: boolean | myBoolFunc;

//This works, with a generic type that can be used anywhere
let myVar2: boolean | Func<[object], boolean>;
于 2020-09-14T19:09:59.887 回答
3

如果你先定义函数类型,那么它看起来像

type Callback = (n: number) => void;

class Foo {
    save(callback: Callback) : void {        
        callback(42);
    }
}

var foo = new Foo();
var stringCallback = (result: string) : void => {
    console.log(result);
}

var numberCallback = (result: number) : void => {
    console.log(result);
}

foo.save(stringCallback); //--will be showing error
foo.save(numberCallback);

如果没有使用普通属性语法的函数类型,它将是:

class Foo {
    save(callback: (n: number) => void) : void {        
        callback(42);
    }
}

var foo = new Foo();
var stringCallback = (result: string) : void => {
    console.log(result);
}

var numberCallback = (result: number) : void => {
    console.log(result);
}

foo.save(stringCallback); //--will be showing error
foo.save(numberCallback);

如果你想使用像 c# generic delegates 这样的接口函数,它会是:

interface CallBackFunc<T, U>
{
    (input:T): U;
};

class Foo {
    save(callback: CallBackFunc<number,void>) : void {        
        callback(42);
    }
}

var foo = new Foo();
var stringCallback = (result: string) : void => {
    console.log(result);
}

var numberCallback = (result: number) : void => {
    console.log(result);
}

let strCBObj:CallBackFunc<string,void> = stringCallback;
let numberCBObj:CallBackFunc<number,void> = numberCallback;

foo.save(strCBObj); //--will be showing error
foo.save(numberCBObj);
于 2019-06-17T05:39:56.827 回答
0

除了其他所说的,一个常见的问题是声明重载的同一函数的类型。典型情况是 EventEmitter on() 方法,它将接受多种侦听器。使用 redux 操作时可能会发生类似情况 - 并且您使用操作类型作为文字来标记重载,如果是 EventEmitters,则使用事件名称文字类型:

interface MyEmitter extends EventEmitter {
  on(name:'click', l: ClickListener):void
  on(name:'move', l: MoveListener):void
  on(name:'die', l: DieListener):void
  //and a generic one
  on(name:string, l:(...a:any[])=>any):void
}

type ClickListener = (e:ClickEvent)=>void
type MoveListener = (e:MoveEvent)=>void
... etc

// will type check the correct listener when writing something like:
myEmitter.on('click', e=>...<--- autocompletion
于 2019-08-13T23:45:39.153 回答
0

function callbackTesting(callbacks: {onYes: (data: any) => void,onNo: (data: any) => void,onError: (err: any) => void,}, type: String){
    switch(type){
        case "one": 
        callbacks.onYes("Print yes");
        break;
        case "two": 
        callbacks.onNo("Print no");
        break;
        default:
        callbacks.onError("Print error");
        break;
    }
}

const onYes1 = (data: any) : void => {
    console.log(data);
}
const onNo1 = (data: any) : void => {
    console.log(data);
}
const onError1 = (data: any) : void => {
    console.log(data);
}



callbackTesting({onYes: function (data: any)  {onYes1(data);},onNo: function (data: any)  {onNo1(data);},onError: function (data: any)  {onError1(data);}}, "one");

callbackTesting({onYes: function (data: any)  {onYes1(data);},onNo: function (data: any)  {onNo1(data);},onError: function (data: any)  {onError1(data);}}, "two");

callbackTesting({onYes: function (data: any)  {onYes1(data);},onNo: function (data: any)  {onNo1(data);},onError: function (data: any)  {onError1(data);}}, "cfhvgjbhkjlkm");

于 2021-05-25T17:02:09.600 回答