{"repo":"windingwind/zotero-types","free":true,"listed":false,"github":"https://github.com/windingwind/zotero-types","clone":"git clone https://github.com/windingwind/zotero-types.git","description":"TypeScript definitions for Zotero.","language":"JavaScript","stars":85,"topics":["api","plugin","types","typescript","typing","zotero","npm","npm-package"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Zotero Types This package contains type definitions for Zotero ( ) plugin. npm package: Installation Run npm install --save-dev zotero-types . Usage Include Type Definitions You can include the type definitions in your Zotero plugin project in three ways: 1. Extend the tsconfig.json file in your Zotero plugin project. This is the recommended way. For the best practices, see as a reference. Available entries: Entry Description Privileged Zotero XUL DOM MainWindow WebWorker ------------ ------------------------------------------------------------------------------------------------------------------- ---------- ------ --- --- ---------- --------- sandbox The default entry for Zotero plugin development. For Zotero plugin's bootstrap.js sandbox environment. ✅ ✅ ❌ ❌ ❌ ❌ xhtml The entry for Zotero's xhtml environment. ✅ ✅ ✅ ✅ ❌ ❌ mainWindow Besides definitions from the xhtml entry, it also includes main window APIs, such as ZoteroPane , Zotero Tabs . ✅ ✅ ✅ ✅ ✅ ❌ html Same as normal HTML environment. ❌ ❌ ❌ ✅ ❌ ❌ webworker Same as normal web worker environment. ❌ ❌ ❌ ❌ ❌ ✅ base The base entry. Does not include any extra type definitions. ❌ ❌ ❌ ❌ ❌ ❌ shared The entry for privileged APIs. ✅ ✅ ❌ ❌ ❌ ❌ 2. Use compileOptions types in your Zotero plugin project's tsconfig.json file. This is equivalent to the combination of sandbox and xhtml entries. 3. Use triple-slash directive in your Zotero plugin project's d.ts file. Similar to the tsconfig.json file, you can use the /// directive to i","default_branch":null,"files":null,"tree":[],"storefront":"/r/windingwind","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/windingwind/zotero-types/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}