Typescript: How to declare the type for a function with custom properties that is returned from an IIFE

Question

Say I have an object like this

const someObject: SomeObject = {
  someMethod: (function() {
    function mainMethod(x) {return x+1}
    yolo.subMethod = function(x) { return x-1 }

    return mainMethod;
  })()
}

I tried defining its type like this:

type SomeObject = {
  someMethod: {
    (x:number): number
    subMethod(x:number): number
  }
}

however I am getting Parameter 'x' implicitly has an 'any' type. warnings in everything inside the IIFE, which means my type is not applied.

I have already read this similar answer however it doesn't seem to work.

I am quite new to TS, and I am not yet familiar with more intricate usecases such as this, so any help would be much appreciated.

You need to declare the type on the `x` parameter, i.e. `mainMethod(x: number)`. Example: https://www.typescriptlang.org/play/?ssl=8&ssc=28&pln=8&pc=34#code/PQKhAIAEBcE8AcCm4TALACg5PAZQPYC2iA8gEYBWiAxtOALzgDem44AzkYgLKLQAW+ACYAucAAoAHmIB2AV0JlEAJwCUDAHzh5ilZgC+mTNXwz2dTsXJVaYglco06jFhjaWefQaIkAzOTK0AJam4uqubGz+gdAhMuCEAIZBMrwCwlKyCkpqzMp8csrxkgDUAIyGbpH50IXxSSlp3gDcrOD6qmEGQA — Terry, Feb 14 '20 at 12:42
Hm, yes I can definitely do this, but it kinda defeats the purpose of having the whole `SomeObject` type declared, if I am to re-declare the parameter types on the functions themselves, no? — Dimitris Karagiannis, Feb 14 '20 at 12:45

score 1 · Accepted Answer · answered Feb 14 '20 at 12:53

Contextual typing (where TS infers parameter types based on expected type) has its limitations. One of them is that the function has to be assigned directly to a typed reference. Since mainMethod is not directly assigned anywhere upon declaration it will not benefit form contextual typing. It will be checked in the return, but it will not be contextually typed.

You will have to declare the parameter types explicitly to the functions. If you want to keep things dry you could define the type in relation to the inferred constant type instead:

const someObject = {
    someMethod: (function () {
        function mainMethod(x: number) { return x + 1 }
        mainMethod.subMethod = function (x: number) { return x - 1 }

        return mainMethod;
    })()
}

type SomeObject = typeof someObject

Playground Link

Typescript: How to declare the type for a function with custom properties that is returned from an IIFE

1 Answers1