Typings definitons for Typscript

I’m trying to use lunr in a fresh Angular 2 app installed with the cli.

In the app.module.ts I’m trying to import lunr with

import { lunr } from 'lunr';

But I keep getting errors about that not being a module, or it not finding it. (yes lunr is in the node_modules folder)

I think/guess that it needs a Typings definition? I found this one. But it seems to be considerably out of date, and doesn’t solve the problem https://www.npmjs.com/package/@types/lunr

Or is that not what I need?

TIA

[jbouzekri]

@kchiragowni : As @gnomeontherun said, there is really nothing special to do.

If you are using angular cli :

npm install --save lunr
npm install --save-dev @types/lunr

In tsconfig.json, add :

{
  "compilerOptions": {
    "types":[
      "lunr"
    ]
  }
}

And in your component ts file, you can do the same thing as in the lunr guide :

import * as lunr from 'lunr';

const idx = lunr(function () {
  this.ref('name')
  this.field('text')

  documents.forEach(function (doc) {
    this.add(doc)
  }, this)
});

[olivernn]

I’m happy to re-open the issue as I think having TypeScript definitions would be awesome.

That said, I really don’t think they should live in this repository.

I’m not familiar with the process of creating a typings file, can this not be something that is automated for each new release? Or some kind of test that can highlight missing or incorrect typings?

Do you have some examples of other JavaScript libraries and where they keep their type definitions?