Custom Typings - How To #11329

Activity

1. mhegazy commented on Oct 3, 2016

   

   Mohamed Hegazy (mhegazy)

   on Oct 3, 2016

   Contributor

   More actions

   What do you mean by "Custom Typings"? what are you looking for specifically?
2. MCKRUZ commented on Oct 3, 2016

   

   Matt Kruczek (MCKRUZ)

   on Oct 3, 2016

   Author

   More actions

   meaning that if I create a NPM library that isn't hosted in NPM but rather a private repo.
3. MCKRUZ commented on Oct 3, 2016

   

   Matt Kruczek (MCKRUZ)

   on Oct 3, 2016

   Author

   More actions

   so it doesn't appear in the typings folder
4. mhegazy commented on Oct 3, 2016

   

   Mohamed Hegazy (mhegazy)

   on Oct 3, 2016

   Contributor

   More actions

   is it a module?
5. MCKRUZ commented on Oct 3, 2016

   

   Matt Kruczek (MCKRUZ)

   on Oct 3, 2016

   Author

   More actions

   Yes it is
6. mhegazy commented on Oct 3, 2016

   

   Mohamed Hegazy (mhegazy)

   on Oct 3, 2016

   Contributor

   More actions

   so let's say you have your declaration file for the module in @private\module\index.d.ts. You can add a path mapping for it.

   {
       "compilerOptions": {
           "baseUrl": "./",
           "paths":{
               "@private/*": ["types/@private/*"]
           }
       }
   }

   would this work?

   👍React with 👍3Reacted by Alex, 7Hd and Matt
7. mhegazy commented on Oct 3, 2016

   

   Mohamed Hegazy (mhegazy)

   on Oct 3, 2016

   Contributor

   More actions

   The ideal case would be the use of typeRoots to inject the additional directory. but this needs #11137 to be fixed first.
8. towertop commented on Nov 18, 2016

   

   Edward (towertop)

   on Nov 18, 2016

   More actions

   Mohamed Hegazy (@mhegazy)

   So what the "paths" options is designed for? That confuses me.
9. mhegazy commented on Nov 18, 2016

   

   Mohamed Hegazy (mhegazy)

   on Nov 18, 2016

   Contributor

   More actions

   So what the "paths" options is designed for? That confuses me.

   what are you trying to do?
10. DanielRosenwasser commented on Nov 18, 2016

    

    Daniel Rosenwasser (DanielRosenwasser)

    on Nov 18, 2016

    Member

    More actions

    Edward (@towertop) The paths field is useful to align TypeScript's module resolution process with that of your module loader (e.g. AMD, System.js), or for adding custom declarations that exist outside of the standard resolution locations.
11. weswigham commented on Nov 19, 2016

    

    Wesley Wigham (weswigham)

    on Nov 19, 2016

    Last edited by weswigham

    Member

    More actions

    Alternatively: Since your packages are private, write your own private @types/module-name package, then point npm at it via your package.json.

    Its higher effort, but, IMO, a much neater solution than managing mappings within your tsconfig. Since your package is private, why not have a private package for its types?
12. towertop commented on Nov 21, 2016

    

    Edward (towertop)

    on Nov 21, 2016

    More actions

    Thanks Daniel Rosenwasser (@DanielRosenwasser) , I got it.

    Mohamed Hegazy (@mhegazy) I was confused which is preferred when "typeRoots" and "paths" both help to patch declarations for external module.
13. Mohamed Hegazy (mhegazy)

    added

    QuestionAn issue which isn't directly actionable in codeAn issue which isn't directly actionable in code

    on Nov 22, 2016
14. Mohamed Hegazy (mhegazy)

    closed this as completedon Dec 29, 2016
15. microsoft

    locked and limited conversation to collaborators on Jun 19, 2018