Typescript: How to use local type declaration file for npm module

Question

in my TypeScript code I want to include a NPM JavaScript module for which there are no typings.

import createPersist = require('vuex-localstorage');

Because of that the compiler complains:

error TS7016: Could not find a declaration file for module 'vuex-localstorage'. '<path>\node_modules\vuex-localstorage\dist\index.js' implicitly has an 'any' type.

One possibility to solve this is setting "noImplicitAny" to false in my tsconfig.json. But this I do not want. I want to know what is not typechecked any more.

So I wrote a minimal type declaration for vuex-localstorage which I put in my project directory:

interface PersistOptions {
    namespace?: string;
    initialState?: any;
    provider?: any;
    serialize?: (data:any) => string;
    deserialize?: (str:string) => any;
    expires?: number;
    merge?: (args:any[]) => any;
    reducer?: (state:any, paths:string[]) => any;
    paths?: string[];
}

declare function createPersist(options: PersistOptions): any;

export = createPersist;

However I still have the same error. I tried several things to get the TypeScript compiler to recognize my type declaration file but nothing worked.

So how do I do it?

Aviad Hadad · Accepted Answer · 2017-03-02 17:24:05Z

9

you need to help the compiler know that what you wrote is for that module.

Try this:

declare module 'vuex-localstorage' {
    interface PersistOptions {
        namespace?: string;
        initialState?: any;
        provider?: any;
        serialize?: (data: any) => string;
        deserialize?: (str: string) => any;
        expires?: number;
        merge?: (args: any[]) => any;
        reducer?: (state: any, paths: string[]) => any;
        paths?: string[];
    }

    function createPersist(options: PersistOptions): any;

    export = createPersist;
}

Don't forget to make sure that this declaration file gets included in tsconfig.json.

answered Mar 2, 2017 at 17:24

Aviad Hadad

1,71712 silver badges17 bronze badges

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

3 Comments

jsf Over a year ago

That did it! Thank you very much

pea3nut Over a year ago

How include the local declaration file in tsconfig.json?

Aviad Hadad Over a year ago

@花生PeA depends on your setup, if you don't have files: or include lines in your tsconfig.json, it will be included by default. If you do have files or include, then just add the path to local declaration file.

Collectives™ on Stack Overflow

Typescript: How to use local type declaration file for npm module

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related