{"_id":"@aidenlx/obsidian","name":"@aidenlx/obsidian","dist-tags":{"latest":"1.1.13"},"versions":{"1.1.13":{"name":"@aidenlx/obsidian","version":"1.1.13","description":"Type definitions for the latest Obsidian API (https://obsidian.md)","keywords":["obsdmd"],"homepage":"https://obsidian.md","repository":{"type":"git","url":"git+https://github.com/obsidianmd/obsidian-api.git"},"license":"MIT","main":"","types":"obsidian.d.ts","dependencies":{"@types/codemirror":"0.0.108","moment":"2.29.4"},"peerDependencies":{"@codemirror/state":"^6.0.0","@codemirror/view":"^6.0.0"},"gitHead":"31cbb322761d1195329c9905ccf77e97b91a0bb3","bugs":{"url":"https://github.com/obsidianmd/obsidian-api/issues"},"_id":"@aidenlx/obsidian@1.1.13","_nodeVersion":"18.12.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-Nw7Mj5Z5nGfPC9WHHgdEoyV6dbc2nVwWji9Ki9hDlM4ZVU62rd1iaezrJM0Lu1cQvsZDa8jGwr4YCwD4EX0rpA==","shasum":"c9859a305688711cae635753fa420f2f3824bd14","tarball":"https://registry.npmjs.org/@aidenlx/obsidian/-/obsidian-1.1.13.tgz","fileCount":7,"unpackedSize":122046,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAFWEALWSPFb/WeypKkHz32nYGk8ynNzw21i3J7PU704AiEAqCkK0OOcoWNdKYdWN43rgukIeE5P+h/Ae2GP7gMA88w="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkHXW/ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoK8g/5ALeeE7GPuVG/I/gGvEfhuHMIu0KAqslRgGiR/hmPNLHIYClf\r\nPlj0fYxgUcetorrH7muhQcUUVcJXsP9cByx8RFGXrp3R3wCHcyqOFPVUQCeF\r\nOOaTF7S334KImVXHOHqaNuP1vcns6/hBzc2Cfpzgj6rTh+jNhZxQ0gEkSrIr\r\nPjy50nGaWhiyjP4qZou5I2Oz7ElzCOAYNvhXRIFh7y4W7ejPKai38msZr+iZ\r\nP1WjeOQNAB773HRX4GiQOvJ94xzxNJfxJRHRMdJZpmHUTEnsIxvx+cIqrY4w\r\nwZqNTHDPBYHVofzx3Y3Q13vHNSaJtRD3h+SRaZ0RlTgLg33pQGfUGJJ5FQyJ\r\nHGlJngssFMFiCRh5JKY6Knplohl9RY7yU45GeAAJNSh5+N0RyXRV9R3JWAx2\r\nvxSKxM1AJ1JLd4thVY2WsPDjbUIbIKEJ5/8yHGjmd3Z0bz3ay1zd82+lsxzB\r\n/k1jQyZXanXkqkzlMXJm6jP7k/NFVl2EWIFBLVQfFAekQVgVSeTUBatT1VNn\r\ngbwt/uKpoKRKL4QKFplo4YvEgMpUQ/1Mb3+oiG/Dr7pih/HL937g4f3lO2Yu\r\n3pHUDm4WaI4P6UCtpiY7Y96++IPLTMq97nLrsQprkI0A0qMc48H92IunOhzf\r\nKDw0cXjDH0owBQXrAI3PG9NxfqQ6vAArDMI=\r\n=xuOH\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"aidenlx","email":"aiden.lx@outlook.com"},"directories":{},"maintainers":[{"name":"aidenlx","email":"aiden.lx@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/obsidian_1.1.13_1679652287459_0.23185344642830752"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-24T10:04:47.314Z","1.1.13":"2023-03-24T10:04:47.639Z","modified":"2023-03-24T10:04:48.136Z"},"maintainers":[{"name":"aidenlx","email":"aiden.lx@outlook.com"}],"description":"Type definitions for the latest Obsidian API (https://obsidian.md)","homepage":"https://obsidian.md","keywords":["obsdmd"],"repository":{"type":"git","url":"git+https://github.com/obsidianmd/obsidian-api.git"},"bugs":{"url":"https://github.com/obsidianmd/obsidian-api/issues"},"license":"MIT","readme":"## Obsidian API\r\n\r\nType definitions for the latest [Obsidian](https://obsidian.md) API.\r\n\r\n### Documentation\r\n\r\nAll API documentation is located in the file `obsidian.d.ts`.\r\nThis will include types, properties, methods, and comments explaining what everything does.\r\n\r\nFor a full example on how to create Obsidian plugins, use the template at https://github.com/obsidianmd/obsidian-sample-plugin \r\n\r\n### Plugin structure\r\n\r\n`manifest.json`\r\n\r\n- `id` the ID of your plugin.\r\n- `name` the display name of your plugin.\r\n- `author` the plugin author's name.\r\n- `version` the version of your plugin.\r\n- `minAppVersion` the minimum required Obsidian version for your plugin.\r\n- `description` the long description of your plugin.\r\n- `isDesktopOnly` whether your plugin uses NodeJS or Electron APIs.\r\n- `authorUrl` (optional) a URL to your own website.\r\n- `fundingUrl` (optional) a link for users to donation to show appreciation and support plugin development.\r\n\r\n`main.js`\r\n\r\n- This is the main entry point of your plugin.\r\n- Import any Obsidian API using `require('obsidian')`\r\n- Import NodeJS or Electron API using `require('fs')` or `require('electron')`\r\n- Must export a default class which extends `Plugin`\r\n- Must bundle all external dependencies into this file, using Rollup, Webpack, or another javascript bundler.\r\n\r\n### App Architecture\r\n\r\n##### The app is organized into a few major modules:\r\n\r\n- `App`, the global object that owns everything else. You can access this via `this.app` inside your plugin. The `App` interface provides accessors for the following interfaces.\r\n- `Vault`, the interface that lets you interact with files and folders in the vault.\r\n- `Workspace`, the interface that lets you interact with panes on the screen.\r\n- `MetadataCache`, the interface that contains cached metadata about each markdown file, including headings, links, embeds, tags, and blocks.\r\n\r\n##### Additionally, by inheriting `Plugin`, you can:\r\n- Add a ribbon icon using `this.addRibbonIcon`.\r\n- Add a status bar (bottom) element using `this.addStatusBarItem`.\r\n- Add a global command, optionally with a default hotkey, using `this.addCommand`.\r\n- Add a plugin settings tab using `this.addSettingTab`.\r\n- Register a new kind of view using `this.registerView`.\r\n- Save and load plugin data using `this.loadData` and `this.saveData`.\r\n\r\n##### Registering events\r\n\r\nFor registering events from any event interfaces, such as `App` and `Workspace`, please use `this.registerEvent`, which will automatically detach your event handler when your plugin unloads:\r\n```\r\nthis.registerEvent(app.on('event-name', callback));\r\n```\r\n\r\nIf you register DOM events for elements that persist on the page after your plugin unloads, such as `window` or `document` events, please use `this.registerDomEvent`:\r\n```\r\nthis.registerDomEvent(element, 'click', callback);\r\n```\r\n\r\nIf you use `setInterval`, please use `this.registerInterval`:\r\n```\r\nthis.registerInterval(setInterval(callback, 1000));\r\n```\r\n","readmeFilename":"README.md"}