typescript augument interface from namespace declared in @types

Question

I'm trying to add the e.g. responsive property into e.g. interface Settings from e.g. node_modules/@types/datatables.net/index.d.ts:

declare namespace DataTables {
    ...
    interface Settings {
    ...

My project is based on https://github.com/gdi2290/angular-starter and I want to use that property with datatables.net-responsive-bs4 which implements it.

Q: How would I write the declaration for adding the responsive property?

PS: I'm specifically interesting in learning how to write that kind of declaration into my project

Adrian · Accepted Answer · 2018-04-11 17:42:32Z

1

There is a difference between augmenting a module and an ambient declaration. In your case the definitions for datatables.net just de declare a namespace and an interface. This means you can just redeclare these in another d.ts file and they will get merged:

// datatables.d.ts
declare namespace DataTables {

    interface Settings {
        responsive : boolean
    }
}

// usage.ts
/// <reference path="./node_modules/@types/datatables.net/index.d.ts" />
/// <reference path="./datatables.d.ts" />

let settings : DataTables.Settings = {
    responsive: true, // ok, from us 
    autoWidth: true // from lib
}

For module augmentation you can have a look here in the module augmentation section.

PS: tslint.json should use at least "allow-declarations" for the rule "no-namespace" otherwise the IDE might trick you by invalidating the declare keyword (e.g. use "no-namespace": [true, "allow-declarations"]).

edited Apr 11, 2018 at 17:42

Adrian

3,8014 gold badges37 silver badges53 bronze badges

answered Apr 11, 2018 at 16:57

Titian Cernicova-Dragomir

253k37 gold badges466 silver badges396 bronze badges

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

Collectives™ on Stack Overflow

typescript augument interface from namespace declared in @types

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related