{"id":13901396,"url":"https://github.com/electron/typescript-definitions","last_synced_at":"2025-05-15T21:05:41.501Z","repository":{"id":12753757,"uuid":"69090878","full_name":"electron/typescript-definitions","owner":"electron","description":"Convert the Electron API JSON file to electron.d.ts","archived":false,"fork":false,"pushed_at":"2025-05-01T21:04:22.000Z","size":1394,"stargazers_count":129,"open_issues_count":4,"forks_count":37,"subscribers_count":42,"default_branch":"main","last_synced_at":"2025-05-06T16:13:50.034Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/electron.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-09-24T08:42:28.000Z","updated_at":"2025-05-01T21:04:25.000Z","dependencies_parsed_at":"2023-01-14T12:20:33.406Z","dependency_job_id":"aa674055-2515-4e6a-b721-15410dd2ecc4","html_url":"https://github.com/electron/typescript-definitions","commit_stats":{"total_commits":377,"total_committers":33,"mean_commits":"11.424242424242424","dds":0.6233421750663131,"last_synced_commit":"c57ff0c592dfe469fd41ba8fbcc0286217920b57"},"previous_names":["electron/electron-typescript-definitions"],"tags_count":114,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Ftypescript-definitions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Ftypescript-definitions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Ftypescript-definitions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Ftypescript-definitions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electron","download_url":"https://codeload.github.com/electron/typescript-definitions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253718134,"owners_count":21952610,"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-08-06T21:01:19.868Z","updated_at":"2025-05-15T21:05:41.484Z","avatar_url":"https://github.com/electron.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Electron TypeScript Definitions\n\nThis module uses Electron's [JSON API documentation](https://github.com/electron/docs-parser) to produce a TypeScript definition file for the Electron API.\n\n[![Test](https://github.com/electron/typescript-definitions/actions/workflows/test.yml/badge.svg)](https://github.com/electron/typescript-definitions/actions/workflows/test.yml)\n[![npm version](http://img.shields.io/npm/v/@electron/typescript-definitions.svg)](https://npmjs.org/package/@electron/typescript-definitions)\n\n## Installation\n\n```sh\nnpm install @electron/typescript-definitions --save\n```\n\n## CLI Usage\n\nTo generate the definitions\n\n```sh\nelectron-typescript-definitions --api=path/to/electron/api.json --out-dir=path/to/out/dir\n```\n\nAny warnings during the generation can normally be ignored unless it actually throws\nan error\n\n## Programmatic Usage\n\nThe module exports a function that parses a given API JSON object and returns\nan array of lines to create the definition file\n\n```js\nimport { generateDefinitions } from '@electron/typescript-definitions'\n\nconst apiPath = './vendor/electron/docs/api.json'\n\nconst definitionLines = generateDefinitions({ electronApi: loadJSON(apiPath) })\n// definitionLines will be an string representation of the definition file\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron%2Ftypescript-definitions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectron%2Ftypescript-definitions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron%2Ftypescript-definitions/lists"}