Browse Source

chore(plugin): bump libs minor version

charlie 3 years ago
parent
commit
9032d67113
2 changed files with 24 additions and 1 deletions
  1. 1 1
      libs/package.json
  2. 23 0
      libs/src/LSPlugin.ts

+ 1 - 1
libs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logseq/libs",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Logseq SDK libraries",
   "main": "dist/lsplugin.user.js",
   "typings": "index.d.ts",

+ 23 - 0
libs/src/LSPlugin.ts

@@ -360,6 +360,11 @@ export interface IAppProxy {
 
   // ui
   queryElementById: (id: string) => Promise<string | boolean>
+
+  /**
+   * @added 0.0.5
+   * @param selector
+   */
   queryElementRect: (selector: string) => Promise<DOMRectReadOnly | null>
 
   /**
@@ -566,6 +571,16 @@ export interface IEditorProxy extends Record<string, any> {
     opts?: Partial<{ includeChildren: boolean }>
   ) => Promise<BlockEntity | null>
 
+  /**
+   * @example
+   *
+   * ```ts
+   *  logseq.Editor.setBlockCollapsed('uuid', true)
+   *  logseq.Editor.setBlockCollapsed('uuid', 'toggle')
+   * ```
+   * @param uuid
+   * @param opts
+   */
   setBlockCollapsed: (
     uuid: BlockUUID,
     opts: { flag: boolean | 'toggle' } | boolean | 'toggle'
@@ -690,6 +705,7 @@ export interface IDBProxy {
  */
 export interface IGitProxy {
   /**
+   * @added 0.0.2
    * @link https://github.com/desktop/dugite/blob/master/docs/api/exec.md
    * @param args
    */
@@ -710,6 +726,13 @@ export type UIMsgOptions = {
 export type UIMsgKey = UIMsgOptions['key']
 
 export interface IUIProxy {
+  /**
+   * @added 0.0.2
+   *
+   * @param content
+   * @param status
+   * @param opts
+   */
   showMsg: (
     content: string,
     status?: 'success' | 'warning' | 'error' | string,