{"id":19973792,"url":"https://github.com/dojo/typings","last_synced_at":"2025-08-20T16:32:40.109Z","repository":{"id":3438649,"uuid":"49503609","full_name":"dojo/typings","owner":"dojo","description":"Dojo 1 - TypeScript Typings (including Dijit and DojoX)","archived":false,"fork":false,"pushed_at":"2023-03-01T02:37:21.000Z","size":1735,"stargazers_count":28,"open_issues_count":25,"forks_count":37,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-12-06T00:03:41.295Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dojo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-01-12T14:02:51.000Z","updated_at":"2023-09-12T16:41:15.000Z","dependencies_parsed_at":"2023-01-14T11:11:56.312Z","dependency_job_id":null,"html_url":"https://github.com/dojo/typings","commit_stats":{"total_commits":353,"total_committers":30,"mean_commits":"11.766666666666667","dds":0.4107648725212465,"last_synced_commit":"99595b015a659667c08fd8e4eba0c497c3c9ba5d"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojo%2Ftypings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojo%2Ftypings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojo%2Ftypings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojo%2Ftypings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dojo","download_url":"https://codeload.github.com/dojo/typings/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230438185,"owners_count":18225870,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T03:12:54.892Z","updated_at":"2024-12-19T13:08:19.253Z","avatar_url":"https://github.com/dojo.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# dojo/typings\n\n[![Build Status](https://travis-ci.org/dojo/typings.svg?branch=master)](https://travis-ci.org/dojo/typings)\n[![npm version](https://badge.fury.io/js/dojo-typings.svg)](http://badge.fury.io/js/dojo-typings)\n\nThis is a repository of Dojo 1 TypeScript Typings (including Dijit and DojoX).\n\nCurrently, this repository does not include all the typings for Dijit and DojoX, although\nDojo is currently fully covered.  The aim is to cover all of Dijit and continue to accept\nany community contributions for DojoX.\n\nFor other packages, because Dojo 2 is built on TypeScript its typings are\ninherent in its distrubution. The goal for affiliated Dojo 1 projects (like\n[dgrid](http://dgrid.io/) and [dstore](http://dstorejs.io/) is that they will include\ntypings as part of their repository.\n\n## Usage\n\nBecause Dojo, Dijit and DojoX are such large and complex code bases, the repository\ntries to break it down into easier to maintain pieces that also allow easy additions,\nmodifications, etc.\n\nEach major namespace is broken down into `dojo`, `dijit` and `dojox` directories, having\nthe major version number in a sub directory within.  Currently only Dojo 1.11 is included.\nThese typings should work for most older versions of Dojo post 1.7, though it may\ninclude some functionality that is not present in those older releases.\n\nThe ambient declarations that mirror the Dojo namespaces are indexed via the `index.d.ts`\nfile located in each directory and the ambient module names are then declared in a single\nfile for the namespace called `modules.d.ts`.  To utilise in a project, where you are\ngoing to import several modules via an AMD loader, you would likely just need to reference\nthe `modules.d.ts`.  If you need to modify the names of the ambient modules to match your\nruntime environment, then you would copy the `modules.d.ts` and rename all the modules as\nrequired.\n\nBasic usage would be to include the `index.d.ts` and likely `modules.d.ts` in files used\neither by `tsc` or in your `tsconfig.json` or referenced within your TypeScript files.\nThe [wiki](https://github.com/dojo/typings/wiki) contains some basic *how to* instructions.\n\nThe easiest way to install the typings is via `npm`:\n\n```sh\n\u003e npm install dojo-typings --save-dev\n```\n\n### Building\n\nThe repository has a `Gruntfile.js` and a development dependency of [grunt](http://gruntjs.com/)\nthat can help validate any changes to the typings.  After cloning the repository and running\n`npm install`, you can then run `grunt` or `grunt dev` which will compile the files with\n`tsc` as well as run `tslint` against the core files.\n\n## Examples\n\nThere are examples of how to use the typings in a TypeScript project located in\nthe `examples` directory of this repository.\n\n## Limitations\n\n### Typings are global\n\nAt the time of this writing (TypeScript 1.7/1.8), typings are global and absolute. In order\nto change module resolution from `dojo/...` the `modules.d.ts` will need to be updated.\n\n### String Literals\n\nThe current typings are built around TypeScript 1.7.  TypeScript 1.8 introduced string\nliteral types and there are improvements that can be made to the typings, several of\nthem noted as comments in the existing typings.\n\n*Note*: while the repository currently uses TypeScript 1.8 as its development dependency\nwe haven't started using the string literals yet.\n\n## Contributing\n\nContributions to this repository are very much welcomed! If you wish to contribute to this repository,\nplease see our [Contributing Guidelines](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdojo%2Ftypings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdojo%2Ftypings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdojo%2Ftypings/lists"}