{"id":15198663,"url":"https://github.com/electron/electron-api-docs","last_synced_at":"2025-10-02T13:31:33.498Z","repository":{"id":57221512,"uuid":"68969171","full_name":"electron/electron-api-docs","owner":"electron","description":":memo: Electron's API documentation in a structured JSON format [ARCHIVED]","archived":true,"fork":false,"pushed_at":"2018-04-03T21:10:37.000Z","size":222,"stargazers_count":9,"open_issues_count":2,"forks_count":11,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-04-14T03:56:18.501Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/electron.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-22T23:02:33.000Z","updated_at":"2023-01-28T20:53:51.000Z","dependencies_parsed_at":"2022-08-29T04:01:54.520Z","dependency_job_id":null,"html_url":"https://github.com/electron/electron-api-docs","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Felectron-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Felectron-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Felectron-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Felectron-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electron","download_url":"https://codeload.github.com/electron/electron-api-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219811496,"owners_count":16547056,"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-09-28T01:23:57.381Z","updated_at":"2025-10-02T13:31:28.042Z","avatar_url":"https://github.com/electron.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# :construction: THIS PROJECT IS NO LONGER MAINTAINED. To get the latest version of Electron's structured docs, see the `electron-api.json` artifact in any Electron releaase: https://github.com/electron/electron/releases\n\n# electron-api-docs [![Build Status](https://travis-ci.org/electron/electron-api-docs.svg?branch=master)](https://travis-ci.org/electron/electron-api-docs)\n\nElectron's API documentation in a structured JSON format.\n\n## Installation\n\n```sh\nnpm install electron-api-docs --save\n```\n\nOr take it for a spin in your Node.js REPL:\n\n```sh\nnpm i -g trymodule \u0026\u0026 trymodule electron-api-docs=apis\n```\n\nNote: This package is not semantically versioned. It is published in step with\nElectron. When you install `electron-api-docs@1.4.1`, you're getting the API\ndocs from Electron v1.4.1.\n\n## Usage\n\nThis module exports structured API data in a few different formats. Choose\nthe one that works best for your use case:\n\n### Object Tree Structure\n\nTo access the docs as a big object tree:\n\n```js\nconst apis = require('electron-api-docs/tree')\n```\n\nThis gives you an object with keys for easy traversal:\n\n```js\napis.BrowserWindow.instanceMethods.setAspectRatio\n```\n\n### Array Structure\n\nTo access the docs as an array of API objects:\n\n```js\nconst apis = require('electron-api-docs/electron-api.json')\n```\n\nThis gives you an array of API objects, so functional methods like `find`,\n`map`, `filter`, and `every` can be used:\n\n```js\napis.find(api =\u003e api.name === 'BrowserWindow')\napis.filter(api =\u003e api.type === 'Class')\napis.filter(api =\u003e api.type === 'Module')\napis.map(api =\u003e api.name)\n```\n\n### Keyed Array Structure\n\nFor the best of both worlds (arrays and objects), you can require the module\nas a [keyed array](https://github.com/zeke/keyed-array):\n\n```js\nconst apis = require('electron-api-docs')\n```\n\nWhen you require it, you get an array of API objects\n\n```js\napis.length\n// =\u003e 33\n```\n\nThe array has a key for each API `name`, for convenient access:\n\n```js\napis.BrowserWindow\napis.BrowserWindow.staticMethods.getAllWindows.description\napis.WebContents.instanceMethods.savePage.parameters.saveType.possibleValues\napis.app.events.quit\n```\n\nAll of the arrays have named keys, but they're still actually arrays, so\nfunctional methods like `find`, `map`, `filter`, and `every` can be used:\n\n```js\napis.find(api =\u003e api.name === 'BrowserWindow')\napis.filter(api =\u003e api.type === 'Class')\napis.filter(api =\u003e api.type === 'Module')\napis.map(api =\u003e api.name)\n\n// All arrays have named keys, not just the top-level array!\napis.BrowserWindow.instanceMethods.map(method =\u003e method.name)\n```\n\n## Tests\n\n```sh\nnpm install\nnpm test\n```\n\n## Dependencies\n\n- [keyed-array](https://github.com/zeke/keyed-array): Recursively add named keys to arrays of objects\n\n## Dev Dependencies\n\n- [chai](https://github.com/chaijs/chai): BDD/TDD assertion library for node.js and the browser. Test framework agnostic.\n- [gh-latest-release](https://github.com/shinnn/gh-latest-release): Get the latest published full release for the Github repository\n- [json](https://github.com/trentm/json): a \u0026#39;json\u0026#39; command for massaging and processing JSON on the command line\n- [mocha](https://github.com/mochajs/mocha): simple, flexible, fun test framework\n- [standard](https://github.com/feross/standard): JavaScript Standard Style\n- [standard-markdown](https://github.com/zeke/standard-markdown): Test your Markdown files for Standard JavaScript Style™\n\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron%2Felectron-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectron%2Felectron-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron%2Felectron-api-docs/lists"}