TypeScript - building .d.ts definition files - Nested functions.

Question

I am in the process of creating TypeScript definitions for RiotJS. This lib uses nested functions like so:

riot.route( args ); // function
riot.route.parser( args ); // function in function

Here is an extract of what I have so far:

declare module riot
{
    export function route( callback : Function ) : void
    export function route( to : string ) : void
}

I am not sure how to structure the definition for the "riot.route.parser()" nested function and wondering if anyone has any insight to share on this ?

Thank you

basarat · Accepted Answer · 2015-03-25 22:13:35Z

5

Here is an implementation that uses inline typing :

declare var riot: {
    route: {
        (callback: Function): void
        parser: {
            (args): any;
        }
    };

}

riot.route(() => null); // function
riot.route.parser(1); // function in function

I recommend you break it up into interfaces, naming them according to a.) either purpose or b.) how actual documentation calls them.

An example to get you started:

interface Riot {
    route: {
        (callback: Function): void
        parser: {
            (args): any;
        }
    };

}
declare var riot:Riot;

riot.route(() => null); // function
riot.route.parser(1); // function in function

Update

for function overloads where the return type / number of arguments do not change I recommend Union Types:

interface Riot {
    route: {
        (toOrCallback: string|Function): void
        (callback: Function): void
        parser: {
            (args): any;
        }
    };

}

edited Mar 25, 2015 at 22:13

answered Mar 25, 2015 at 10:48

basarat

278k61 gold badges475 silver badges528 bronze badges

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

2 Comments

user2386872 Over a year ago

Thank you. Out of interest how would you overload the 'route' function with definition. i.e. : 'export function route( callback : Function ) : void export function route( to : string ) : void' Or would you just just any for the callback ?

user2386872 Over a year ago

Clever - I would give you another thumbs up for that if I could. Thank you again .

Collectives™ on Stack Overflow

TypeScript - building .d.ts definition files - Nested functions.

1 Answer 1

Update

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Update

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related