Namespaces for interfaces in typescript definition file

Question

I am writing a TypeScript definition file (.d.ts) for a JS library that doesn't currently have one.

Other .d.ts file seem to put all the types into the 'global' namespace (if you see what I mean), whereas I am trying do the following:

// root valerie object 
//
declare var valerie: Valerie.ValerieStatic;

// additional types for Valerie (all inside this virtual namespace)

declare module Valerie {

    //
    // Static methods on valerie namespace
    //
    interface ValerieStatic {
        // definitions go here.....

This means that I don't potentially get my interfaces crossed with others should they exist.

My question is - it seems to work, but is there a possible problem with this approach?

Ryan Cavanaugh · Accepted Answer · 2013-10-15 16:38:23Z

2

In general this is a good approach. If there are some interface types inside the Valerie module that you would expect people to be using often, you might consider promoting them to top-level so it's more convenient to reference them.

answered Oct 15, 2013 at 16:38

Ryan Cavanaugh

223k59 gold badges280 silver badges235 bronze badges

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

1 Comment

Quango Over a year ago

Thanks for the confirmation - I was wondering why others didn't follow this approach which made me concerned I was erring from the true path. :)

Collectives™ on Stack Overflow

Namespaces for interfaces in typescript definition file

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related