Reference index.d.ts types in package.json #22
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As recommended in http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html,
the
package.json
should contain a reference to the type declarations fileindex.d.ts
.In addition to being best practice, it avoids some potential problems:
Without this reference, someone could have a project with the following
tsconfig.json
:Currently, if any file in their project has
import { deserialize } from "json-typescript-mapper";
, thenjson-typescript-mapper/index.ts
will not be excluded bytsc
. Therefore, when compiling their project withstrictNullChecks: true
,json-typescript-mapper/index.ts
will be be incorrectly checked bytsc
, and generate the following errors:Adding the
index.d.ts
reference topackage.json
allowstsc
to correctly ignorejson-typescript-mapper
.