{"componentChunkName":"component---src-templates-handbook-tsx","path":"/docs/handbook/declaration-files/publishing.html","result":{"data":{"markdownRemark":{"id":"8a6799a9-3227-50b6-8490-f4042efa142a","excerpt":"Now that you have authored a declaration file following the steps of this guide, it is time to publish it to npm.\nThere are two main ways you can publish your…","html":"

Now that you have authored a declaration file following the steps of this guide, it is time to publish it to npm.\nThere are two main ways you can publish your declaration files to npm:

\n
    \n
  1. bundling with your npm package, or
    2. \n
  2. publishing to the @types organization on npm.
    3. \n
\n

If your package is written in TypeScript then the first approach is favored.\nUse the --declaration flag to generate declaration files.\nThis way, your declarations and JavaScript will always be in sync.

\n

If your package is not written in TypeScript then the second is the preferred approach.

\n

Including declarations in your npm package

\n

If your package has a main .js file, you will need to indicate the main declaration file in your package.json file as well.\nSet the types property to point to your bundled declaration file.\nFor example:

\n
json
{\n    \"name\": \"awesome\",\n    \"author\": \"Vandelay Industries\",\n    \"version\": \"1.0.0\",\n    \"main\": \"./lib/main.js\",\n    \"types\": \"./lib/main.d.ts\"\n}
\n

Note that the \"typings\" field is synonymous with \"types\", and could be used as well.

\n

Also note that if your main declaration file is named index.d.ts and lives at the root of the package (next to index.js) you do not need to mark the \"types\" property, though it is advisable to do so.

\n

Dependencies

\n

All dependencies are managed by npm.\nMake sure all the declaration packages you depend on are marked appropriately in the \"dependencies\" section in your package.json.\nFor example, imagine we authored a package that used Browserify and TypeScript.

\n
json
{\n    \"name\": \"browserify-typescript-extension\",\n    \"author\": \"Vandelay Industries\",\n    \"version\": \"1.0.0\",\n    \"main\": \"./lib/main.js\",\n    \"types\": \"./lib/main.d.ts\",\n    \"dependencies\": {\n        \"browserify\": \"latest\",\n        \"@types/browserify\": \"latest\",\n        \"typescript\": \"next\"\n    }\n}
\n

Here, our package depends on the browserify and typescript packages.\nbrowserify does not bundle its declaration files with its npm packages, so we needed to depend on @types/browserify for its declarations.\ntypescript, on the other hand, packages its declaration files, so there was no need for any additional dependencies.

\n

Our package exposes declarations from each of those, so any user of our browserify-typescript-extension package needs to have these dependencies as well.\nFor that reason, we used \"dependencies\" and not \"devDependencies\", because otherwise our consumers would have needed to manually install those packages.\nIf we had just written a command line application and not expected our package to be used as a library, we might have used devDependencies.

\n

Red flags

\n

/// <reference path=\"...\" />

\n

Don’t use /// <reference path=\"...\" /> in your declaration files.

\n
ts
/// <reference path=\"../typescript/lib/typescriptServices.d.ts\" />\n....
\n

Do use /// <reference types=\"...\" /> instead.

\n
ts
/// <reference types=\"typescript\" />\n....
\n

Make sure to revisit the Consuming dependencies section for more information.

\n

Packaging dependent declarations

\n

If your type definitions depend on another package:

\n\n

Publish to @types

\n

Packages under the @types organization are published automatically from DefinitelyTyped using the types-publisher tool.\nTo get your declarations published as an @types package, please submit a pull request to https://github.com/DefinitelyTyped/DefinitelyTyped.\nYou can find more details in the contribution guidelines page.

","headings":[{"value":"Including declarations in your npm package","depth":1},{"value":"Dependencies","depth":2},{"value":"Red flags","depth":2},{"value":"/// ","depth":3},{"value":"Packaging dependent declarations","depth":3},{"value":"Publish to @types","depth":1}],"frontmatter":{"permalink":"/docs/handbook/declaration-files/publishing.html","title":"Publishing"}}},"pageContext":{"slug":"/docs/handbook/declaration-files/publishing.html","isOldHandbook":true}}}