Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Where are the docs for writing a typings.json file? #27

Open
EisenbergEffect opened this issue Jun 26, 2016 · 4 comments
Open

Where are the docs for writing a typings.json file? #27

EisenbergEffect opened this issue Jun 26, 2016 · 4 comments

Comments

@EisenbergEffect
Copy link

I've been poking around but can't seem to find the documentation for writings typings.json files. I've got some basics in place but need to do something a bit different. I need a repo to not have a main but instead a list of d.ts files that it exports. I'm thinking I could add a files property and list them, but I can't find any docs to confirm that.

@EisenbergEffect
Copy link
Author

See this repo for reference: https://github.com/aurelia/typings

We'd like to enable someone to install that repo with typings and get all the dts files in the dist folder. I'm just not sure how to author the typings file correctly for this scenario.

@blakeembrey
Copy link
Member

@phreed
Copy link

phreed commented Jul 18, 2016

It works for me, here is an example.

{
    "name": "webgme",
    "main": "webgme.d.ts",
    "files":    [
        "./blobjs.d.ts",
        "./pluginjs.d.ts",
        "./webgme.d.ts",
        "./webgmeV1.d.ts"],
    "global": true,
    "dependencies": {
    },
    "devDependencies": {},
    "globalDependencies": {
        "q": "registry:dt/q#0.0.0+20160613154756"
    },
    "globalDevDependencies": {
    }
}

The git repository has each of the *.d.ts files.
When typings install retrieves the files they are concatenated into a single 'index.d.ts' file with the main appearing first.

@EisenbergEffect
Copy link
Author

@phreed Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants