Declare object property in typescript definition file

Question

I have a function that returns a boolean. The function also has a property errors as an array. It is in a module.

example.js

exports["example"] = myFunc;
function myFunc(data) {
  return true;
}
myFunc.errors = ['error']

I can define the function return signature in a typescript .d.ts file;

example.d.ts

export declare function uploadedFile(data: any): boolean;

but I don't know how to define the functions errors property so that it should return a string array?

export declare function uploadedFile(data: any): boolean;
export declare property uploadedFile.errors: Array<string>; // ??

possible duplicate of stackoverflow.com/questions/12766528/…? — Bergi
– Bergi, Commented Aug 9, 2021 at 15:22

Bergi · Accepted Answer · 2021-08-09 15:22:22Z

1

You can declare it as an object with a call signature:

export declare var uploadedFile: {
  (data: any): boolean;
  errors: string[];
};

answered Aug 9, 2021 at 15:22

Bergi

671k162 gold badges1k silver badges1.5k bronze badges

Sign up to request clarification or add additional context in comments.

Comments

henriale · Accepted Answer · 2021-08-09 15:08:32Z

0

To declare the property errors you can change the second declaration to namespace like this:

export declare function uploadedFile(data: any): boolean;
export declare namespace uploadedFile {
    errors: Array<String>;
}

answered Aug 9, 2021 at 15:08

henriale

1,0429 silver badges22 bronze badges